[tor-commits] [sbws/master] Divide TOC in sections, rearange pages order

[juga at torproject.org]

commit 9b40dc1880531559007b65411d728dbdd4934bcf
Author: juga0 <juga at riseup.net>
Date:   Tue Sep 18 15:15:49 2018 +0000

    Divide TOC in sections, rearange pages order
---
 docs/source/index.rst | 49 ++++++++++++++++++++++++++++++++++---------------
 1 file changed, 34 insertions(+), 15 deletions(-)

diff --git a/docs/source/index.rst b/docs/source/index.rst
index 098268d..2a16343 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -6,40 +6,59 @@
 Welcome to Simple Bandwidth Scanner's documentation!
 ====================================================
 
-Contents
---------
+User main documentation
+------------------------
+
+Included in the
+`repository root <https://gitweb.torproject.org/sbws.git//tree/>`_
+and in ``sbws`` Debian package:
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
-   specification
-   config
+   README
    INSTALL
    DEPLOY
-   README
-   man_sbws
-   man_sbws.ini
-   CHANGELOG
    CONTRIBUTING
+   CHANGELOG
    AUTHORS
-   LICENSE
+   man_sbws
+   man_sbws.ini
+
+.. _dev_doc:
+
+Developer/technical documentation
+----------------------------------
+
+Included in the
+`docs directory <https://gitweb.torproject.org/sbws.git/tree/docs>`_ and in
+``sbws-doc`` Debian package:
+
+.. toctree::
+   :maxdepth: 1
+
+   specification
    faq
    glossary
-   diagrams
+   layout
+   config_tor
+   testing
+   documenting
    state
+   config
+   diagrams
    sbws
 
-Proposals
----------
+Proposals:
 
 .. toctree::
-   :glob:
    :maxdepth: 1
+   :glob:
 
    proposals/*
 
 Indices and tables
-==================
+-------------------
 
 * :ref:`genindex`
 * :ref:`modindex`