python - Generating documentation using Pydoc -

python - Generating documentation using Pydoc -

i need generate documentation comments using pydoc. looks tutorial links in pydoc.org broken , can't find how it. can explain?

if want utilize pydoc, can in terminal:

$ pydoc -w myproject

this generate old-school html documentation doctrings. note pydoc module used in python since 2.1 help() function. retrieve docstrings not comments. should describe functions using docstrings.

but kind of old-school using pydoc documentation generating. popular tool in python sphinx. you'll need format docstrings in particular format restructuredtext.

have there info concerning docstrings formatting.

you can utilize pyment generate docstring skeletons or convert existing ones particular format.

python documentation pydoc