Newbie can't figure out documentation practices
Aahz
aahz at pythoncraft.com
Fri May 9 09:20:58 EDT 2003
In article <slrnbbn9g6.qt7.A.Christofides at acheloos.itia.civil.ntua.gr>,
Antonios Christofides <A.Christofides at itia.ntua.gr> wrote:
>
>I don't understand how I am supposed to do this in Python. I know I can
>write documentation strings, but is there any command that can read them
>and format them into something like a man page or even plain text? I
>thought it would be pydoc, but it doesn't seem to work like perldoc. I'm
>almost concluding there's no standard way, and people are choosing
>whatever they like, e.g. pod, groff, DocBook, or LaTeX. No problem with
>that, I just want to make sure my conclusion is correct.
That's currently true; however, there's overall a slow movement toward
reStructuredText as the doc format of the future. See
http://docutils.sf.net/
--
Aahz (aahz at pythoncraft.com) <*> http://www.pythoncraft.com/
"In many ways, it's a dull language, borrowing solid old concepts from
many other languages & styles: boring syntax, unsurprising semantics,
few automatic coercions, etc etc. But that's one of the things I like
about it." --Tim Peters on Python, 16 Sep 93
More information about the Python-list
mailing list