Was this page helpful?
Use the command-line interface to run the following commands.
To run the following commands, you will need to have installed:
A Unix-based terminal. For Windows, use Windows Subsystem for Linux.
Python 3.7 or later.
Poetry #.12 or later.
Make.
Git.
The preview command builds a local instance of the docs site so you can view the rendering in a sandbox environment on your local browser.
To preview the docs:
Build the docs.
cd docs make preview
Open http://127.0.0.1:5500/ with your preferred browser.
Tip
You can pass custom options to increase or decrease verbosity. For a list with all the available options, refer to the Sphinx documentation.
To increase verbosity, use the option -v:
make preview SPHINXOPTS=-v
To decrease verbosity, use the option -Q:
make preview SPHINXOPTS=-Q
The multiversionpreview command generates a local instance of the docs site with all specified versions available for navigation. You can view the rendering in a sandbox environment on your local browser.
To preview multiple versions:
Build the docs.
cd docs make multiversionpreview
Open http://0.0.0.0:5500/ with your preferred browser.
For further guidance on using the multiversionpreview command, see Multiversion configuration.
Note
The command make multiversion is aimed to be used by GitHub Actions CI. While documenting new features, it is not advised to run make multiversion, but make preview instead.
cd docs
make multiversion
The previous command generates HTML docs under the docs/_build/dirhtml directory.
The make preview operation creates content in the _build directory. When making changes to the docs, it is helpful to delete the contents of this directory before running make preview.
cd docs
make clean
Check for broken links on the documentation site.
cd docs
make dirhtml
make linkcheck
Was this page helpful?