- Install the latest Sphinx version:
python3 -m pip install sphinx - Set PATH if you installed it with the
--userkey:PATH="/Users/<user>/Library/Python/<version>/bin:$PATH" - Install the extensions used in this project:
python3 -m pip install sphinx-tabs sphinxcontrib.plantuml sphinx_copybutton sphinxcontrib.contentui
- Go to the source files directory:
cd <local-path-to-the-repo>/docs/ - Build artifacts:
make htmlfor HTML artifacts ormake latexpdffor PDF artifacts (don't forget to install LaTeX before building PDF artifacts).