Compiling the Documentation

The compilation of the documentation is essentially a review of the process carried out in Code Documentation with Sphinx and UI Testing. The main differences are that the Python code is now in a package instead of a module. This means that there’s a directory of files instead of a single file. Nevertheless, the changes will be minor.

Set up Sphinx

We begin by installing Sphinx as a dev-only install for the server project in the langman/server directory, then using sphinx-quickstart to create a new project. Here, we demonstrate how to do it by specifying the options at the command line rather than specifying them interactively as we did in Code Documentation with Sphinx.

1. You can try the following code in the terminal below. Press “Enter” for the prompts triggered by pipenv run sphinx-quickstart --project "Langman" --author "Erik M. Ferragut" --sep --ext-autodoc docs.