The documentation is generated using Sphinx and the generated documentation is hosted here.

You will need to have Python and SCons installed. To install the rest of the build dependencies

make install_deps

Then, to get help on available build targets, just type

make

• How to document your Python docstrings

To link to a Autobahn class:

:py:class:`autobahn.websocket.protocol.WebSocketProtocol`

To link to a Python stdlib class:

:py:class:`zipfile.ZipFile`

Or to link to Python 2 or Python 3 specifically:

:py:class:`zipfile.ZipFile <py2:zipfile.ZipFile>`
:py:class:`zipfile.ZipFile <py3:zipfile.ZipFile>`

To link to a Twisted class:

:tx:`twisted.internet.defer.Deferred`