17.2 Installing Sphinx and creating documentation

A README file is a summary of the software touching on a few key points. Proper documentation often parallels the important topics of the README, but in more depth.

Important adjuncts to the essential ”how-to” guides include two important topics:

• What the software does. This is often a detailed description of the observable features.

• How the software works, showing the implementation concepts.

The C4 model suggests four tiers of abstraction in the description:

1. The context in which an application is used.

2. The containers in which the software runs.

3. Component diagrams showing the architecture of the software.

4. Code diagrams showing the implementation details.

This organization offers the necessary focus for documentation.

We...