1
0
mirror of synced 2024-12-23 01:33:07 +01:00
Tapeti/docs/README.md

14 lines
373 B
Markdown
Raw Normal View History

The documentation can be built locally using Sphinx. Install Python 3 (choco install python on Windows),
then install sphinx and the ReadTheDocs theme:
```pip install sphinx sphinx_rtd_theme```
To build the HTML output, run:
```.\make.bat html```
To use the auto reloading server (rundev.bat), install the sphinx-autobuild package:
```pip install sphinx-autobuild```