f081159f15
This builds both asyncio and Twisted documentation, all inside a virtualenv. I took the "sphinx-build" commands out of SCons because I couldn't get them to work from there properly within a virtualenv -- perhaps I'm just missing something easy here though.
1.3 KiB
1.3 KiB
Documentation
The documentation is generated using Sphinx and the generated documentation is hosted here.
Prerequisites
You will need to have Python and SCons installed. To install the rest of the build dependencies
make install_deps
Note: If you want to use this in a virtualenv, you'll have to install the SCons package for your distribution and use virtualenv --system-site-packages to build the venv. Then, activate it and install dependencies as above. To run SCons you'll have to do python `which scons` so that it uses the interpreter from your virtualenv.
Then, to get help on available build targets, just type
make
Cheatsheets
Linking to Python objects
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`