Tapeti/docs
Mark van Renswoude e31d638a11 Implemented a rate limiting option for Tapeti.Cmd
Moved example 06 to the "examples" sub-folder
2020-07-03 15:51:41 +02: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
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 Implemented stateless request-response support 2020-02-12 11:34:51 +01:00
gettingstarted.rst Added integration packages for Autofac, Castle Windsor, Ninject and Unity IoC containers 2019-08-19 16:36:26 +02:00
indepth.rst Added support for the Obsolete attribute to remove bindings and queues with backwards compatibility 2019-08-20 11:47:53 +02:00
index.rst Added logging for binding operations 2020-03-05 10:27:46 +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 Implemented a rate limiting option for Tapeti.Cmd 2020-07-03 15:51:41 +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