Template for the Read the Docs tutorial

Example RTD template project

---

This GitHub template includes fictional Python library with some basic Sphinx docs.

The created documentation can be found at

https://brainelectronics-tutorial-template.readthedocs.io/en/latest/

• Getting started
  • Install required tools
  • Create documentation

Getting started

Install required tools

Python3 must be installed on your system. Check the current Python version with the following command

python --version
python3 --version

Depending on which command Python 3.x.y (with x.y as some numbers) is returned, use that command to proceed.

# create and activate virtual environment
python3 -m venv .venv
source .venv/bin/activate

# install and upgrade required packages
pip install -U -r docs/requirements.txt

Create documentation

# perform link checks
sphinx-build docs/ docs/build/linkcheck -d docs/build/docs_doctree/ --color -blinkcheck -j auto -W

# create documentation
sphinx-build docs/ docs/build/html/ -d docs/build/docs_doctree/ --color -bhtml -j auto -W

The created documentation can be found here.

Errors thrown due to invalid autosectionlabels or by invalid references to files not being part of the docs/ folder are ignored, see suppress_warnings in docs config