Autobahn|Python Documentation
The Autobahn|Python reference documentation is generated using Sphinx and available online.
To generate the documentation yourself you will need to have Autobahn|Python installed locally plus install Sphinx:
pip install sphinx
pip install sphinx_rtd_theme
pip install sphinxcontrib-spelling
pip install repoze.sphinx.autointerface
and then
cd doc
sphinx-build -b html . _html
This will create the documentation under
_html
Custom Page Content
To add custom page content to the generated pages, modify templates/layout.html.
Publishing
Note: this section is only relevant for administrators of the Autobahn web site.
To publish to the Autobahn web site (here), you will need SCons and Taschenmesser.
Then do
scons
to build the docs and
scons publish
to build and publish the docs and
scons -uc
to cleanup.