code documentation for python

python documentation documentation-generation
Alex. S. picture Alex. S. · Mar 11, 2009 · Viewed 15.1k times · Source

What is out there on conventions and tools for documenting python source code?

Answer

vartec picture vartec · Mar 11, 2009

Conventions: PEP 257 and PEP 8. Note, that docstrings can be written in reStructuredText

Tools for generating documentation: for example Sphinx

Related questions

How do I create documentation with Pydoc?

I'm trying to create a document out of my module. I used pydoc from the command-line in Windows 7 using Python 3.2.3: python "<path_to_pydoc_>\pydoc.py" -w myModule This led to my shell being filled with text, one …

Read More
How to document a method with parameter(s)?

How to document methods with parameters using Python's documentation strings? EDIT: PEP 257 gives this example: def complex(real=0.0, imag=0.0): """Form a complex number. Keyword arguments: real -- the real part (default 0.0) imag -- the imaginary part (default 0.0) """ if imag == 0.0 and …

Read More
How to build sphinx documentation for django project

I have a django project, which I document using reST in docstrings to do the following: Help diagloags within IDE Later on to build HTML documentation using Sphinx My documentation shows up properly within IDE (PyCharm), however I can't configure …

Read More