Dainty

mirror of

History

Mark van Renswoude 8c25fa790b Renamed docs folder for ReadTheDocs compatibility		2020-09-13 23:05:08 +02:00
..
Dainty.Docs.sublime-project	Renamed docs folder for ReadTheDocs compatibility	2020-09-13 23:05:08 +02:00
Makefile	Renamed docs folder for ReadTheDocs compatibility	2020-09-13 23:05:08 +02:00
README.md	Renamed docs folder for ReadTheDocs compatibility	2020-09-13 23:05:08 +02:00
conf.py	Renamed docs folder for ReadTheDocs compatibility	2020-09-13 23:05:08 +02:00
gettingstarted.rst	Renamed docs folder for ReadTheDocs compatibility	2020-09-13 23:05:08 +02:00
index.rst	Renamed docs folder for ReadTheDocs compatibility	2020-09-13 23:05:08 +02:00
introduction.rst	Renamed docs folder for ReadTheDocs compatibility	2020-09-13 23:05:08 +02:00
make.bat	Renamed docs folder for ReadTheDocs compatibility	2020-09-13 23:05:08 +02:00
rundev.bat	Renamed docs folder for ReadTheDocs compatibility	2020-09-13 23:05:08 +02:00

README.md

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