3575fc337d
A port of the existing user manual over to reStructuredText and using Sphinx to generate the documentation to see if it would be a suitable replacement for the existing php generated method.
23 lines
497 B
Plaintext
23 lines
497 B
Plaintext
Install Sphinx
|
|
--------------
|
|
Install Sphinx from Debian repositories:
|
|
|
|
apt-get install python-sphinx
|
|
|
|
Install Sphinx using virtualenv (assumes virtualenv is already installed):
|
|
|
|
virtualenv venv
|
|
source venv/bin/activate
|
|
pip install -r requirements.txt
|
|
|
|
|
|
Build Documentation
|
|
-------------------
|
|
The documentation can be generated using the following commands
|
|
|
|
cd docs/
|
|
make html
|
|
|
|
The documentation should now be available in `_build/` directory under the
|
|
`docs/` directory.
|