...
Working in the root of the repository, issue the following command to generate documentation. This assumes you have Python and Tox installed on the machine where you are working. Note a common error message (see below) comes from RST formatting warning (warnings treated as errors). Fix the underlying RST (in the example that's installation-guides.rst) and try again.
| No Format |
|---|
tox -e docs,docs-linkcheck
### Possible/typical error message in the output
Warning, treated as error:
/home/fedora/tmp/doci/aaa/docs/index.rst:23:toctree contains reference to document 'installation-guides' that doesn't have a title: no link will be generated
ERROR: InvocationError for command '/home/fedora/tmp/doci/aaa/.tox/docs-linkcheck/bin/sphinx-build -W -b linkcheck -d /home/fedora/tmp/doci/aaa/.tox/docs-linkcheck/tmp/doctrees ./docs/ /home/fedora/tmp/doci/aaa/docs/_build/linkcheck' (exited with code 2)
|
Step 4: Add a link to your-repo documentation
...