Compiling the Documentation
Understand how to compile documentation for a full stack web app by setting up Sphinx for Python package docs, linking static Storybook UI components, and generating HTML output. This lesson guides you through configuring Sphinx, creating symbolic links or copies for Storybook, and updating index files to produce complete project documentation.
We'll cover the following...
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 ...