better TOC structure for a better sidebar

Wikidata · Jul 18, 2019 · 2ed05a9 · 2ed05a9
1 parent c31f024
commit 2ed05a9
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 10 deletions.
diff --git a/docs/cli.rst b/docs/cli.rst
@@ -1,7 +1,9 @@
-The Command Line
+.. _clidoc:
+
+The command line
 ================
 
-.. note:: Start your exploration journey of the command line interface (*CLI*) with ::
+.. note:: start your exploration journey of the command line interface (*CLI*) with ::
 
    $ python -m soweego
 

diff --git a/docs/contribute.rst b/docs/contribute.rst
@@ -1,3 +1,7 @@
+Contribution guidelines
+=======================
+
+
 Workflow
 --------
 
@@ -24,7 +28,7 @@ Coding
 3. **Documentation** - write `Sphinx <https://www.sphinx-doc.org/>`_ docstrings at least for public functions and classes:
 
     - use `reST <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_ markup;
-    - stick to `PEP 257 <https://www.python.org/dev/peps/pep-0257/>`_ and _`PEP 287 <https://www.python.org/dev/peps/pep-0287/>`_;
+    - stick to `PEP 257 <https://www.python.org/dev/peps/pep-0257/>`_ and `PEP 287 <https://www.python.org/dev/peps/pep-0287/>`_;
     - pay special attention to `info field lists <https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#info-field-lists>`_;
     - `cross-reference <https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#cross-referencing-python-objects>`_ Python objects.
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -52,7 +52,9 @@ Highlights
 Get Ready
 ---------
 
-Install `Docker <https://docs.docker.com/install/>`_, then enter soweego::
+Install `Docker <https://docs.docker.com/install/>`_
+and `Compose <https://docs.docker.com/compose/install/>`_,
+then enter soweego::
 
    $ git clone https://github.com/Wikidata/soweego.git
    $ cd soweego
@@ -120,6 +122,8 @@ Just two things to remember:
 1. you can always get ``--help``;
 2. each command may have sub-commands.
 
+Find all details in the :ref:`cli_docs`.
+
 
 How-tos
 -------
@@ -130,10 +134,11 @@ How-tos
    pipeline
    new_catalog
    dev_prod
-   recordlinkage
 
 
-CLI documentation
+.. _cli_docs:
+
+CLI Documentation
 -----------------
 
 .. toctree::
@@ -142,7 +147,7 @@ CLI documentation
    cli
 
 
-API documentation
+API Documentation
 -----------------
 
 .. toctree::
@@ -159,16 +164,27 @@ API documentation
 Contribute
 ----------
 
-.. note:: The best way is to :ref:`new`.
+.. note:: the best way is to :ref:`new`.
 
-Please have a look at the following guidelines.
+Please have a look here:
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
 
    contribute
 
 
+Experiments & notes
+-------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   experiments
+   evaluations
+   recordlinkage
+
+
 License
 -------