[Doc-SIG] Referencing specific function/class inside howto
castor at snafu.de
Mon Aug 18 20:54:22 EDT 2003
i am not sure i understood the question completely, but epydoc+docutils
is able to reference functions in modules included in one documentation
build. you would simple write `mymodule.xy` and there you are.
i am using the docutils together with epydoc, and find i can recommend
the combo as the best source documentation solution available for
python. i did patch a few lines in epydoc and wrote an additional module
to do file globbing, though, but in most cases it should work with simply
setting up epydoc and docutils and then issue sth along the lines of
pathto\epydoc.py --target doc --css blue --docformat restructuredtext *.py
from the directory where your sources live. of course, this makes only sense
if your sources are python files, for otherwise epydoc couldn't handle them.
unfortunately, since file globbing didn't seem to work with the last release
of epydoc, you may have to replace the ``*.py`` with a list of all your
i think it would make sense to urge the developer of epydoc to get some
really minor quirks out of the current release, write one or two short
scripts and perhaps even make a docutils/epydoc bundle so developers and
laymen alike can install and run it with even less hassle than today.
ps. for those interested, http://python.org/pypi?:action=display&name=tracy&version=0.1
provides docs & sources as an example application of the epydoc+docutils.
>Subject: Re: [Doc-SIG] Referencing specific function/class inside howto
> From: "Fred L. Drake, Jr." <fdrake at acm.org>
> Date: Mon, 18 Aug 2003 11:18:00 -0400
> To: Lars Immisch <lars at ibp.de>
> Cc: doc-sig at python.org
>Lars Immisch writes:
> > I am using the existing Python documentation framework to write a howto
> > for some internal software.
> > I want to reference specific functions and/or classes from other
> > functions/classes, not just sections. To invent an example that
> > hopefully illustrates my point:
>I'm afraid that's not currently supported, though I've started
>thinking about ways to introduce that. I haven't had a lot of time to
>spend on it yet.
>Fred L. Drake, Jr. <fdrake at acm.org>
>PythonLabs at Zope Corporation
>Doc-SIG maillist - Doc-SIG at python.org
More information about the Doc-SIG