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
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month, and much more.