python - Generating documentation using Pydoc -


I need to generate documentation from comments using pydoc. It seems that the tutorial link in pydoc.org is broken And I do not know how to do it. Can anyone explain? If you really want to use Pydoc, you can do just one terminal:

ex> $ pydoc -w myproject

This will generate an old-school HTML document from docting. Note that Pydoc is the module used in Python, which is 2.1 for the help () function. It will retrieve docstrings which are not comments , you should describe your actions using the dotstring.

But to make this document, using Paidak is an old school. There is a popular tool to do that in Python, but you will need to convert your doctrostring to a specific format, because the restructured text.

Take a look to get some information about document formatting.

You can also use to make a doctoring skeleton or to convert the existing form to a particular form.


Comments