[tor-commits] [sbws/master] Explain how to build docs. Remove obsolete

[pastly@xxxxxxxxxxxxxx]

commit b16d5c0113c7bfe299336ddc2515e5f1c5ff8247
Author: juga0 <juga@xxxxxxxxxx>
Date:   Tue Aug 28 15:11:56 2018 +0000

    Explain how to build docs. Remove obsolete
---
 INSTALL.rst | 31 +++++++++----------------------
 1 file changed, 9 insertions(+), 22 deletions(-)

diff --git a/INSTALL.rst b/INSTALL.rst
index f83489d..b774ae2 100644
--- a/INSTALL.rst
+++ b/INSTALL.rst
@@ -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.



_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits