FREE Virtual Training Event | April 22, 2021
Register Now >

Commands

To run the next commands you will need to have installed Python 3.7 and PIP.

Preview current branch

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:

  1. Build the docs.

cd docs
make preview
  1. Open http://127.0.0.1:5500/ with your preferred browser.

You can pass custom options to increase or decrease verbosity. For a list of all the available options, refer to the Sphinx documentation. For example:

make preview SPHINXOPTS=-v

Preview multiversion

The multiversionpreview 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:

  1. Build the docs.

cd docs
make previewmultiversion
  1. Open http://0.0.0.0:5500/ with your preferred browser.

If the version drop-down menu does not contain the all of the listed versions, try to run git fetch --tags to download the latest tags from remote.

Build HTML for the current branch

To generate an HTML version:

  1. Build the docs.

cd docs
make dirhtml
  1. The previous command should generate HTML docs under the docs/_build/dirhtml directory.

Build HTML for multiple versions

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.

To generate multiple versions of the documentation:

  1. Build the docs.

cd docs
make multiversion
  1. The previous command should generate HTML docs under the docs/_build/dirhtml directory.

Clean all builds

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