DEPRECATED!

• Note: docs.smartnoise.org is now built directly from the SmartNoise SDK repository

---

docs.smartnoise.org

Building the Docs

The steps below assume the use of Homebrew on a Mac.

Note that Python 3.8 is required. Python 3.9 is known not to work with the synthesizers packages.

/usr/local/opt/python\@3.8/bin/python3 -m venv venv
source venv/bin/activate
python -m pip install --upgrade pip
pip install -r requirements.txt
make html
open build/html/index.html

Deployment

Docs are deployed to http://docs.smartnoise.org using GitHub Actions.

Note that make html is replaced with make versions to build multiple versions (branches, tags) using the sphinx-multiversion extension.

Join the Discussion

You are very welcome to join us on GitHub Discussions!