Tapeti/docs
Mark van Renswoude cf244ba3ff Added documentation for IFlowParallelRequest 2021-12-10 12:53:18 +01:00
..
Makefile Added the start of the ReadTheDocs documentation 2017-02-11 14:32:07 +01:00
README.md Added logging for binding operations 2020-03-05 10:27:46 +01:00
Tapeti.Docs.sublime-project Added the start of the ReadTheDocs documentation 2017-02-11 14:32:07 +01:00
compatibility.rst [skip appveyor] Added ASP.NET compatibility documentation 2021-11-07 10:54:30 +01:00
conf.py Wrote some more documentation 2017-02-11 21:32:30 +01:00
dataannotations.rst [ci skip] Fixed wrong port being used for management API 2019-08-15 15:55:45 +02:00
flow.rst Added documentation for IFlowParallelRequest 2021-12-10 12:53:18 +01:00
gettingstarted.rst [skip appveyor] Added ASP.NET compatibility documentation 2021-11-07 10:54:30 +01:00
indepth.rst Added documentation for #37 2021-10-29 21:07:53 +02:00
index.rst [skip appveyor] Added ASP.NET compatibility documentation 2021-11-07 10:54:30 +01:00
introduction.rst Reintroduced the separate introduction page, as it was causing tree issues on ReadTheDocs 2019-08-20 12:55:12 +02:00
make.bat Added the start of the ReadTheDocs documentation 2017-02-11 14:32:07 +01:00
rundev.bat [skip appveyor] #9 Documentation and examples 2019-08-16 13:45:31 +02:00
tapeticmd.rst Split parts into separate repositories 2021-10-07 15:38:43 +02:00
transient.rst [skip appveyor] #9 Documentation and examples 2019-08-16 13:45:31 +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