#66 Epytext image inclusion

[Chris Leary]

I was hoping to find an image inclusion indicator for HTML and latex outputs in the Epytext markup -- hopefully I haven't missed it somewhere.

I think it would be a neat feature to implement that has reasonable cross-output functionality between the HTML, LaTeX and plain text types -- I guess plain text output could just have a [reference: some_diagram.png; caption: Some interesting text.] Maybe a grammar something like P{Caption text<photo_location>} for "Photo" since I is taken by "Italics"?

If I missed it somewhere, then I guess this is a doc request to add a section on images to the Epytext manual :)

Thanks,

Chris

[Edward Loper]

Logged In: YES
user_id=195958
Originator: NO

You didn't miss it, it's not there. Epytext is a very lightweight markup language, and it doesn't have support for including images. If you want to have more advanced markup features (such as images, tables, etc), I recommend you take a look at reStructuredText [1,2] -- it's a nice markup language, and epydoc has full support for it. Just be sure to set __docformat__ [1] (which you should do even if you use epytext), so epydoc will know what markup language to expect.

But if you decide reStructuredText doesn't fit your needs, and you still think adding images to epytext is what you want, I'm willing to consider it. But there's a number of issues that would need to be worked out, such as where to find images (filenames? urls? relative to the module?), how to handle scaling in different output formats, etc.

[1] http://docutils.sourceforge.net/rst.html
[2] http://epydoc.sourceforge.net/manual-othermarkup.html

[Chris Leary]

Logged In: YES
user_id=1853846
Originator: YES

I understand the desire to keep the Epytext markup as simple as possible, so if you don't find it pertinent to include an "image" feature I can understand. I was immediately drawn to Epytext over RST because of its similarity to Javadoc with the @ -- it was an easy transition. I guess my feature request was just to let you know there might be interest for such a feature :)

Also, it would be neat if you could include a note in the Epytext documentation that there is /no/ support for images, and that if you intend on including images that you recommend RST.

If you feel like working out a method for including images in Epytext, I'd be happy to have some theoretical discussions -- just LMK and I'll subscribe to the listserv.

Thanks for writing this awesome documentation utility, and have a great day :)

- Chris