Re: [Epydoc-devel] Documentation not associated with a particular module, function, class, or method

[Daniele V. <pi...@de...>]

Joseph Turian ha scritto:
> I am understanding someone else's code, and helping to document it as I 
> understand it.
> The author was explaining to me and using the term "graph". Graph is not 
> actually a particular module, function, class, or method.
> It is just an umbrella concept tying together a lot of things.
> 
> We are trying to write documentation for the "graph" concept.
> We would prefer to write it using epytext markup (as opposed to 
> independent HTML documentation) so that links to epydoc-generated HTML 
> is created.

Have you considered the use of reStructuredText syntax to produce your 
documentation? Just like epytext it can be used to produce API documentation 
with Epydoc, but it is already geared towards the production of standalone 
documents too (with titles, ToC, metadata etc.) and is ready to produce html, 
pdf and some other fancy format.

Epydoc also contains a script - apirst2html.py - allowing a standalone reST 
document to reference API docs generated with Epydoc itself, e.g. citing 
:api:`some_function()` or :api:`module.Class`. The script converts the 
document into HTML and links the objects marked with the above syntax to the 
matching epydoc-generated API docs.

-- 
Daniele Varrazzo - Develer S.r.l.
http://www.develer.com