Expert Python Programming - Third Edition

Documentation as code

The best way to keep the documentation of your project up to date is to treat it as code and store it in the same repository as the source code it documents. Keeping documentation sources with the source code has the following benefits:

• With a proper version control system, you can track all changes that were made to the documentation. If you ever wonder if a particular surprising code behavior is really a bug or just an old and forgotten feature, you can dive into the history of the documentation to trace how the documentation for the specific feature evolved over time.
• It is easier to develop different versions of the documentation if the project has to be maintained on several parallel branches (for example, for ...