DOC: more site re-org

jklymak · jklymak · commit 26fcdefd5e32 · 2021-10-01T16:10:46.000+02:00
The root of the index is users/index
Most material is now under users/
diff --git a/doc/_templates/mpl_nav_bar.html b/doc/_templates/mpl_nav_bar.html
@@ -10,15 +10,12 @@
     <a class="reference internal nav-link" href="{{ pathto('tutorials/index') }}">Tutorials</a>
   </li>
   <li class="nav-item">
-    <a class="reference internal nav-link" href="{{ pathto('api/index') }}">Reference</a>
+    <a class="reference internal nav-link" href="{{ pathto('api/index') }}">API Reference</a>
   </li>
   <li class="nav-item">
-    <a class="reference internal nav-link" href="{{ pathto('contents') }}">Usage guide</a>
+    <a class="reference internal nav-link" href="{{ pathto('users/index') }}">Users guide</a>
   </li>
   <li class="nav-item">
-    <a class="reference internal nav-link" href="{{ pathto('devel/index') }}">Develop</a>
-  </li>
-  <li class="nav-item">
-    <a class="reference internal nav-link" href="{{ pathto('users/release_notes') }}">Release notes</a>
+    <a class="reference internal nav-link" href="{{ pathto('devel/index') }}">Contributing</a>
   </li>
 </ul>
diff --git a/doc/api/index.rst b/doc/api/index.rst
@@ -1,5 +1,5 @@
-Reference
-=========
+API Reference
+=============
 
 When using the library you will typically create
 :doc:`Figure <figure_api>` and :doc:`Axes <axes_api>` objects and
diff --git a/doc/conf.py b/doc/conf.py
@@ -206,7 +206,7 @@ def _check_dependencies():
 source_encoding = "utf-8"
 
 # The master toctree document.
-master_doc = 'contents'
+master_doc = 'users/index'
 
 # General substitutions.
 try:
diff --git a/doc/contents.rst b/doc/contents.rst
diff --git a/doc/index.rst b/doc/index.rst
@@ -53,7 +53,7 @@ Learning resources
     - :doc:`Quick-start guide <tutorials/introductory/usage>`
     - :doc:`Plot types <plot_types/index>`
     - `Introductory tutorials <../tutorials/index.html#introductory>`_
-    - :doc:`External learning resources <resources/index>`
+    - :doc:`External learning resources <users/resources/index>`
 
     ---
 
@@ -67,7 +67,7 @@ Learning resources
     Understand how Matplotlib works
     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-    - The :ref:`users-guide-explain` in the :doc:`Usage guide <users/index>`
+    - The :ref:`users-guide-explain` in the :doc:`Users guide <users/index>`
     - Many of the :ref:`Intermediate <tutorials-intermediate>` and
       :ref:`Advanced <tutorials-advanced>` tutorials
       have explanatory material
@@ -106,7 +106,7 @@ you can help!
 - or improve the :ref:`documentation and code <developers-guide-index>`
 
 
-Site map
---------
+Users guide
+-----------
 
-The :ref:`complete contents of the docs <complete_sitemap>`.
+The `contents of the docs <users/index.html>`_.
diff --git a/doc/users/backmatter.rst b/doc/users/backmatter.rst
@@ -6,6 +6,6 @@ Project information
     :maxdepth: 1
 
     license.rst
-    ../citing.rst
+    citing.rst
     credits.rst
     history.rst
diff --git a/doc/users/citing.rst b/doc/users/citing.rst
@@ -1,4 +1,5 @@
-:orphan:
+.. redirect-from:: /citing
+
 
 Citing Matplotlib
 =================
diff --git a/doc/users/faq/environment_variables_faq.rst b/doc/users/faq/environment_variables_faq.rst
@@ -1,5 +1,7 @@
 .. _environment-variables:
 
+.. redirect-from:: /faq/environment_variables_faq
+
 *********************
 Environment variables
 *********************
diff --git a/doc/users/faq/howto_faq.rst b/doc/users/faq/howto_faq.rst
@@ -1,5 +1,7 @@
 .. _howto-faq:
 
+.. redirect-from:: /faq/howto_faq
+
 ******
 How-to
 ******
diff --git a/doc/users/faq/index.rst b/doc/users/faq/index.rst
@@ -1,8 +1,10 @@
 .. _faq-index:
 
-######
-How-to
-######
+.. redirect-from:: /faq/index
+
+##########################
+How-to and troubleshooting 
+##########################
 
 .. only:: html
 
diff --git a/doc/users/faq/installing_faq.rst b/doc/users/faq/installing_faq.rst
@@ -1,5 +1,7 @@
 .. _installing-faq:
 
+.. redirect-from:: /faq/installing_faq
+
 **************
 Installing FAQ
 **************
diff --git a/doc/users/faq/troubleshooting_faq.rst b/doc/users/faq/troubleshooting_faq.rst
@@ -1,5 +1,7 @@
 .. _troubleshooting-faq:
 
+.. redirect-from:: /faq/troubleshooting_faq
+
 ***************
 Troubleshooting
 ***************
diff --git a/doc/users/index.rst b/doc/users/index.rst
@@ -1,7 +1,10 @@
 .. _users-guide-index:
 
+.. redirect-from:: /contents
+
+
 ###########
-Usage guide
+Users guide
 ###########
 
 .. only:: html
@@ -15,10 +18,14 @@ Usage guide
 .. toctree::
    :maxdepth: 2
 
+   installing.rst
    ../plot_types/index.rst
    ../tutorials/index.rst
    ../gallery/index.rst
    explain.rst
-   ../faq/index.rst
+   faq/index.rst
    ../api/index.rst
-   ../resources/index.rst
+   resources/index.rst
+   ../devel/index.rst
+   backmatter.rst
+   release_notes.rst
diff --git a/doc/users/release_notes.rst b/doc/users/release_notes.rst
@@ -20,8 +20,11 @@ Version 3.4
     prev_whats_new/github_stats_3.4.1.rst
     prev_whats_new/github_stats_3.4.0.rst
 
+Past versions
+=============
+
 Version 3.3
-===========
+~~~~~~~~~~~
 .. toctree::
     :maxdepth: 1
 
@@ -35,7 +38,7 @@ Version 3.3
     prev_whats_new/github_stats_3.3.0.rst
 
 Version 3.2
-===========
+~~~~~~~~~~~
 .. toctree::
     :maxdepth: 1
 
@@ -46,7 +49,7 @@ Version 3.2
     prev_whats_new/github_stats_3.2.0.rst
 
 Version 3.1
-===========
+~~~~~~~~~~~
 .. toctree::
     :maxdepth: 1
 
@@ -59,7 +62,7 @@ Version 3.1
     prev_whats_new/github_stats_3.1.0.rst
 
 Version 3.0
-===========
+~~~~~~~~~~~
 .. toctree::
     :maxdepth: 1
 
@@ -72,15 +75,15 @@ Version 3.0
     prev_whats_new/github_stats_3.0.0.rst
 
 Version 2.2
-===========
+~~~~~~~~~~~
 .. toctree::
     :maxdepth: 1
 
     prev_whats_new/whats_new_2.2.rst
     ../api/prev_api_changes/api_changes_2.2.0.rst
 
 Version 2.1
-===========
+~~~~~~~~~~~
 .. toctree::
     :maxdepth: 1
 
@@ -90,7 +93,7 @@ Version 2.1
     ../api/prev_api_changes/api_changes_2.1.0.rst
 
 Version 2.0
-===========
+~~~~~~~~~~~
 .. toctree::
     :maxdepth: 1
 
@@ -99,7 +102,7 @@ Version 2.0
     ../api/prev_api_changes/api_changes_2.0.0.rst
 
 Version 1.5
-===========
+~~~~~~~~~~~
 .. toctree::
     :maxdepth: 1
 
@@ -109,23 +112,23 @@ Version 1.5
     ../api/prev_api_changes/api_changes_1.5.0.rst
 
 Version 1.4
-===========
+~~~~~~~~~~~
 .. toctree::
     :maxdepth: 1
 
     prev_whats_new/whats_new_1.4.rst
     ../api/prev_api_changes/api_changes_1.4.x.rst
 
 Version 1.3
-===========
+~~~~~~~~~~~
 .. toctree::
     :maxdepth: 1
 
     prev_whats_new/whats_new_1.3.rst
     ../api/prev_api_changes/api_changes_1.3.x.rst
 
 Version 1.2
-===========
+~~~~~~~~~~~
 .. toctree::
     :maxdepth: 1
 
@@ -134,22 +137,22 @@ Version 1.2
     ../api/prev_api_changes/api_changes_1.2.x.rst
 
 Version 1.1
-===========
+~~~~~~~~~~~
 .. toctree::
     :maxdepth: 1
 
     prev_whats_new/whats_new_1.1.rst
     ../api/prev_api_changes/api_changes_1.1.x.rst
 
 Version 1.0
-===========
+~~~~~~~~~~~
 .. toctree::
     :maxdepth: 1
 
     prev_whats_new/whats_new_1.0.rst
 
 Version 0.x
-===========
+~~~~~~~~~~~
 .. toctree::
     :maxdepth: 1
 
diff --git a/doc/users/resources/index.rst b/doc/users/resources/index.rst
@@ -1,5 +1,7 @@
 .. _resources-index:
 
+.. redirect-from:: /resources/index
+
 ******************
 External resources
 ******************
diff --git a/examples/README.txt b/examples/README.txt
@@ -10,5 +10,5 @@ This page contains example plots. Click on any image to see the full image
 and source code.
 
 For longer tutorials, see our `tutorials page <../tutorials/index.html>`_.
-You can also find `external resources <../resources/index.html>`_ and
-a `FAQ <../faq/index.html>`_ in our `user guide <../contents.html>`_.
+You can also find `external resources <../users/resources/index.html>`_ and
+a `FAQ <../users/faq/index.html>`_ in our `user guide <../users/index.html>`_.

-Original file line number
+Diff line change
@@ @@ -1,5 +1,7 @@ @@
 .. _howto-faq:
 +.. redirect-from:: /faq/howto_faq
++
 ******
 How-to
 ******