Re: [Epydoc-devel] How to use custom images?

[Edward L. <ed...@se...>]

> Hi!
 >  Just a quick question.
 >  It's possible to use custom images to improve documentation, in example png?

 It's possible if you use reStructuredText as your markup language,
 using the "..image::" directive.  But epydoc doesn't currently copy
 the image into the target directory, so you'll have to do that
 yourself.  A simple example:

 --------- start of foo.py -----------
 """
 Here's an image:

 .. image:: face.png
 """
 __docformat__ = 'restructuredtext'
 --------- end of foo.py -----------

 And then you'd need to copy "face.png" into the output directory where
 epydoc wrote its files.  Alternatively, you could do something like:

 --------- start of foo.py -----------
 """
 Here's an image:

 .. image:: ../images/face.png
 """
 __docformat__ = 'restructuredtext'
 --------- end of foo.py -----------

 Assuming that there will be a directory 'images' that is a sister to
 the directory where epydoc writes its output.

 -Edward