Documenting a package with Pydoc
Rob Cowie
cowie.rob at gmail.com
Fri Aug 18 10:45:51 EDT 2006
I have searched this group and the wider net to find an answer to this,
but I haven't been successful.
Pydoc seems to be capable of writing documentation for all modules
within a package by simply pointing it to the package on the command
line...
pydoc -w <packagename_without_/>
Certainly, the method writedocs() appears to descend into a directory
and create docs for each importable object.
Perhaps I'm doing something wrong but when I do this, pydoc reports
that no Python documentation can be found for each of the contents of
the package. Of course, if I point pydoc directly to the modules, it
succeeds.
Am I doing something wrong?
Cheers, Rob C
More information about the Python-list
mailing list