[tor-commits] [sbws/master] Add extra dependencies for docs. Remove obsolete

[pastly@xxxxxxxxxxxxxx]

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

    Add extra dependencies for docs. Remove obsolete
---
 INSTALL.rst | 24 ++++++++----------------
 1 file changed, 8 insertions(+), 16 deletions(-)

diff --git a/INSTALL.rst b/INSTALL.rst
index 9eac885..f83489d 100644
--- a/INSTALL.rst
+++ b/INSTALL.rst
@@ -66,27 +66,19 @@ To run the tests::
 
     tox
 
-    Run these commands one at a time and check for errors before continuing.
 
-Updating
-~~~~~~~~
-
-::
+Installing documentation dependendencies and building it
+---------------------------------------------------------
 
-    cd simple-bw-scanner
-    git pull
-    # Determine the newest released version. Assuming it is v1.5.3 ...
-    git checkout v1.5.3
-    source venv/bin/activate
-    pip install --process-dependency-links --upgrade-strategy eager --upgrade .
+To build the documentation, extra Python dependencies are needed:
 
+- Sphinx_
+- recommonmark_
+- Pylint_ (only to update the diagrams)
 
-[OBSOLETE DO NOT FOLLOW] Virtualenv - Development
-------------------------------------------------------------------------------
+To install them from ``sbws``::
 
-These are almost exactly the same. The difference is the pip command: we
-install sbws in an editable state so we don't have to re-run pip every time we
-make a change.
+    pip install .[doc]
 
 ::
 



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