Serious Python

3DOCUMENTATION AND GOOD API PRACTICE

In this chapter, we’ll discuss documentation; specifically, how to automate the trickier and more tedious aspects of documenting your project with Sphinx. While you will still have to write the documentation yourself, Sphinx will simplify your task. As it is common to provide features using a Python library, we’ll also look at how to manage and document your public API changes. Because your API will have to evolve as you make changes to its features, it’s rare to get everything built perfectly from the outset, but I’ll show you a few things you can do to ensure your API is as user-friendly as possible.

We’ll ...