Mastering Object-Oriented Python - Second Edition

Quality and Documentation

To be valuable, software must be trusted. The general goal of trustworthiness relies on a number of software quality attributes. For more information on this, refer to the S-Cube Quality Reference Model section in https://s-cube-network.eu/km/qrm/index.html. Good documentation is an underlying technique for demonstrating that the various quality attributes have been met.

In this chapter, we'll look at two tools to produce the documentation from the code: pydoc and Sphinx. The pydoc tool extracts documentation from the Python code and produces useful views of the docstrings. The Sphinx tool allows us to create complete and sophisticated documentation using a lightweight markup language coupled with the source code. ...