Using pydoc for documentation
We use the library module pydoc
to produce HTML documentation from Python code. It turns out that we're using it when we evaluate the help()
function in interactive Python. This function produces the text mode documentation with no markup.
When we use pydoc
to produce the documentation, we'll use it in one of the following three ways:
- Prepare text-mode documentation files and view them with command-line tools such as
more
orless
- Prepare HTML documentation and save a file for browsing later
- Run an HTTP server and create the HTML files as needed for browsing immediately
We can run the following command-line tool to prepare the text-based documentation for a module:
pydoc somemodule
We can also use the following code:
python3.3 ...
Get Mastering Object-oriented Python now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.