Documentation
The Autobahn|Python documentation is generated using Sphinx and the generated documentation is hosted here.
Generate
You will need to have SCons installed, plus the following
pip install taschenmesser
pip install sphinx
pip install sphinx-bootstrap-theme
pip install sphinxcontrib-spelling
pip install repoze.sphinx.autointerface
To generate the documentation
cd doc
scons
This will create the documentation under the directory _build.
Test
To build the documentation and start a Web server
scons test
Clean
To clean up all build artifacts
scons -uc
Publish
Note: this section is only relevant for administrators of the Autobahn web site.
Publishing requires a 2 step process.
First do
scons
to build the docs and second do
scons publish
to actually publish the docs.