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

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

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

         Manuel

> 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

Thanks.
But unfortunately it not work here (I'm working with Windows)...

I've uploaded the test:

http://www.makehuman.org/tmp/epydoc_test.zip

The result has not img tags:

---------------------
   <table width="100%" cellpadding="0" cellspacing="0" border="0">
   <tr valign="top"><td>
   <h3 class="epydoc"><span class="sig"><span 
class="sig-name">foo</span>()</span>
   </h3>
   </td><td align="right" valign="top"
     ><span class="codelink"><a 
href="foo-pysrc.html#foo">source&nbsp;code</a></span>&nbsp;

     </td>
   </tr></table>

   <p>Here's an image: .. image:: img_04.png</p>
   <dl class="fields">
   </dl>
</td></tr></table>
-------------------------

Maybe it's my error.
Anyway no warning from epydoc console.
Can you take a look?

Regards,

          Manuel

PS:: the image is not in the zip, but for me it's sufficient to see
a generated img tag...

Edward Loper ha scritto:
>> 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
> 
> -------------------------------------------------------------------------
> This SF.net email is sponsored by: Microsoft
> Defy all challenges. Microsoft(R) Visual Studio 2008.
> http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
> _______________________________________________
> Epydoc-devel mailing list
> Epy...@li...
> https://lists.sourceforge.net/lists/listinfo/epydoc-devel
> 
> 
> 

Manuel ha scritto:
> Thanks.
> But unfortunately it not work here (I'm working with Windows)...

There is no problem with docutils on windows: it is a pure Python module. Of 
course you have to install the docutils package (from 
http://docutils.sourceforge.net)

There are two glitches in your example:

1. the __docformat__ must be a module variable, not a class variable;

2. in reST syntax you need a blank line above the directives (i.e. image).

Below the fixed example, which works as expected.

     __docformat__ = 'restructuredtext'

     def foo():

          """
          Here's an image:

          .. image:: img_04.png
          """
          pass

Regards,

-- Daniele