Skip to content
Snippets Groups Projects
Commit b16d5c01 authored by juga's avatar juga
Browse files

Explain how to build docs. Remove obsolete

parent f92a1027
No related branches found
No related tags found
No related merge requests found
......@@ -80,35 +80,22 @@ To install them from ``sbws``::
pip install .[doc]
::
git clone https://github.com/pastly/simple-bw-scanner.git
cd simple-bw-scanner
git checkout v1.5.3
virtualenv -p python3 venv-editable
source venv-editable/bin/activate
pip install --process-dependency-links --editable .
sbws init
To build the documentation as HTML::
.. note::
cd docs/ && make html
Because we relay on a ``-dev`` version of stem, we need to fetch it from
git.torproject.org. Thus ``--process-dependency-links`` is necessary.
The generated HTML will be in `docs/build/`.
.. warning::
To build the manual (``man``) pages::
Run these commands one at a time and check for errors before continuing.
cd docs/ && make man
Updating
~~~~~~~~
The generated man pages will be in `docs/man/`.
::
To build the documentation diagrams::
cd simple-bw-scanner
git pull
# Determine the newest released version. Assuming it is v1.5.3 ...
git checkout v1.5.3
cd docs/ && make umlsvg
.. todo::
The generated diagrams will be in `docs/build/images/`.
This doesn't update dependencies and needs to be fixed.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment