How to Use Sphinx for Writing Docs

How to Get the Dependencies

With your favorite python package manager, e.g., pip, install sphinx, spinx_multiversion, and sphinx_rtd_theme. For example:

pip install sphinx
pip install sphinx_multiversion
pip install sphinx_rtd_theme

How to Build .rst into .html

After you have the dependencies in your environment, then simply build your documentation as the following:

make html

Note

You can view the documentation webpage locally on your web browser by passing in the URL as file:///path/to/spiner/doc/sphinx/_build/html/index.html

How to Deploy

  1. Submit a PR with your .rst changes for documentation on Github ports-of-call

  2. Get your PR reviewed and merged into main

  3. Make sure the pages CI job passes in the CI pipeline

As soon as the PR is merged into main, this will trigger the Pages deployment automatically if the pages CI job passes.

Documentation is available on github-pages.

More Info.