[tor-commits] [sbws/master] Create page for documentation instructions

[juga@xxxxxxxxxxxxxx]

commit 364390f90298af0eb7ec650014871198231c719c
Author: juga0 <juga@xxxxxxxxxx>
Date:   Tue Sep 18 15:04:24 2018 +0000

    Create page for documentation instructions
---
 DOCUMENTATION.rst => docs/source/documenting.rst | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

diff --git a/DOCUMENTATION.rst b/docs/source/documenting.rst
similarity index 59%
rename from DOCUMENTATION.rst
rename to docs/source/documenting.rst
index 6410f2c..c610121 100644
--- a/DOCUMENTATION.rst
+++ b/docs/source/documenting.rst
@@ -1,4 +1,4 @@
-.. _documentation:
+.. _documenting:
 
 Installing documentation dependendencies and building it
 ---------------------------------------------------------
@@ -30,3 +30,18 @@ To build the documentation diagrams::
     cd docs/ && make umlsvg
 
 The generated diagrams will be in ``docs/build/_images/``.
+
+To convert the ``LaTeX`` mathematical formulae to images, extra system dependencies
+are needed:
+
+- Core and Extra Tex_ Live packages
+
+They are included in most distributions. In Debian install them running::
+
+    apt install texlive-latex-extra
+
+
+.. _Sphinx: http://www.sphinx-doc.org
+.. _recommonmark: https://recommonmark.readthedocs.io/
+.. _Pylint: https://www.pylint.org/
+.. _Tex: http://www.tug.org/texlive/acquire.html



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