a | b/docs/README.md | ||
---|---|---|---|
1 | To build the documentation, please install |
||
2 | * the [sphinx-autotoc-typehints](https://github.com/agronholm/sphinx-autodoc-typehints) extension |
||
3 | * the [Read the Docs Sphinx theme](https://github.com/readthedocs/sphinx_rtd_theme) |
||
4 | * the [nbsphinx](https://github.com/spatialaudio/nbsphinx) extension |
||
5 | |||
6 | and then run |
||
7 | ``` |
||
8 | python -m sphinx source <build-dir> |
||
9 | ``` |
||
10 | in this directory. |