- Python 3.9+
- Sphinx: https://www.sphinx-doc.org/en/master/usage/installation.html
- Python venv:
pip install -U sphinx - Ubuntu:
apt install python3-sphinx - Mac:
brew install sphinx-doc - Windows:
choco install sphinx
- Python venv:
- PlantUML: https://plantuml.com/en/download
- Ubuntu:
apt install plantuml - Mac:
brew install plantuml - Windows:
choco install plantuml
- Ubuntu:
- PlantUML for Sphinx:
pip install -U sphinxcontrib-plantuml - (optional) Atlassian® Confluence® Builder for Sphinx:
pip install -U sphinxcontrib-confluencebuilder
- Ubuntu/Mac:
make html - Windows:
make.bat html
The created pages are in _build/html.