[tor-commits] [sbws/master] Move building documentation to a different file

[juga@xxxxxxxxxxxxxx]

commit 4075c4d725c9a2adc96a43a8dde89bd8c54c1e50
Author: juga0 <juga@xxxxxxxxxx>
Date:   Fri Sep 14 18:51:15 2018 +0000

    Move building documentation to a different file
---
 DOCUMENTATION.rst | 32 ++++++++++++++++++++++++++++++++
 INSTALL.rst       | 31 -------------------------------
 2 files changed, 32 insertions(+), 31 deletions(-)

diff --git a/DOCUMENTATION.rst b/DOCUMENTATION.rst
new file mode 100644
index 0000000..6410f2c
--- /dev/null
+++ b/DOCUMENTATION.rst
@@ -0,0 +1,32 @@
+.. _documentation:
+
+Installing documentation dependendencies and building it
+---------------------------------------------------------
+
+To build the documentation, extra Python dependencies are needed:
+
+- Sphinx_
+- recommonmark_
+- Pylint_ (only to update the diagrams)
+
+To install them from ``sbws``::
+
+    pip install .[doc]
+
+To build the documentation as HTML::
+
+    cd docs/ && make html
+
+The generated HTML will be in ``docs/build/``.
+
+To build the manual (``man``) pages::
+
+    cd docs/ && make man
+
+The generated man pages will be in ``docs/man/``.
+
+To build the documentation diagrams::
+
+    cd docs/ && make umlsvg
+
+The generated diagrams will be in ``docs/build/_images/``.
diff --git a/INSTALL.rst b/INSTALL.rst
index 5832f3b..5ad7875 100644
--- a/INSTALL.rst
+++ b/INSTALL.rst
@@ -48,37 +48,6 @@ Install the python dependencies::
 ``sbws`` needs :term:`destination` s to request files from.
 Please, see :ref:`deploy` to know how to configure, deploy and run ``sbws``.
 
-Installing documentation dependendencies and building it
----------------------------------------------------------
-
-To build the documentation, extra Python dependencies are needed:
-
-- Sphinx_
-- recommonmark_
-- Pylint_ (only to update the diagrams)
-
-To install them from ``sbws``::
-
-    pip install .[doc]
-
-To build the documentation as HTML::
-
-    cd docs/ && make html
-
-The generated HTML will be in ``docs/build/``.
-
-To build the manual (``man``) pages::
-
-    cd docs/ && make man
-
-The generated man pages will be in ``docs/man/``.
-
-To build the documentation diagrams::
-
-    cd docs/ && make umlsvg
-
-The generated diagrams will be in ``docs/build/_images/``.
-
 System physical requirements
 -----------------------------
 



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