This chapter will cover Python documentation. Specifically, we will discuss how to document code, both within your program and through external documents. We will cover:
- Python documentation tools and techniques
- In-line comments and the dir command
- Using docstrings
- Using PyDoc help
- HTML reports
- Using reStructuredText files
- Using the Sphinx documentation program
- Using the LaTeX and LyX document preparation programs