DOC: more site re-org · matplotlib/matplotlib@7eb99af · GitHub
Skip to content

Commit 7eb99af

Browse files
jklymakjklymak
committed
DOC: more site re-org
The root of the index is users/index Most material is now under users/
1 parent 66687d0 commit 7eb99af

16 files changed

Lines changed: 58 additions & 63 deletions

‎doc/_templates/mpl_nav_bar.html‎

Lines changed: 3 additions & 6 deletions

‎doc/api/index.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Reference
2-
=========
1+
API Reference
2+
=============
33

44
When using the library you will typically create
55
:doc:`Figure <figure_api>` and :doc:`Axes <axes_api>` objects and

‎doc/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ def _check_dependencies():
213213
source_encoding = "utf-8"
214214

215215
# The master toctree document.
216-
master_doc = 'contents'
216+
master_doc = 'users/index'
217217

218218
# General substitutions.
219219
try:

‎doc/contents.rst‎

Lines changed: 0 additions & 25 deletions
This file was deleted.

‎doc/index.rst‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Learning resources
5353
- :doc:`Quick-start guide <tutorials/introductory/usage>`
5454
- :doc:`Plot types <plot_types/index>`
5555
- `Introductory tutorials <../tutorials/index.html#introductory>`_
56-
- :doc:`External learning resources <resources/index>`
56+
- :doc:`External learning resources <users/resources/index>`
5757

5858
---
5959

@@ -67,7 +67,7 @@ Learning resources
6767
Understand how Matplotlib works
6868
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6969

70-
- The :ref:`users-guide-explain` in the :doc:`Usage guide <users/index>`
70+
- The :ref:`users-guide-explain` in the :doc:`Users guide <users/index>`
7171
- Many of the :ref:`Intermediate <tutorials-intermediate>` and
7272
:ref:`Advanced <tutorials-advanced>` tutorials
7373
have explanatory material
@@ -106,7 +106,7 @@ you can help!
106106
- or improve the :ref:`documentation and code <developers-guide-index>`
107107

108108

109-
Site map
110-
--------
109+
Users guide
110+
-----------
111111

112-
The :ref:`complete contents of the docs <complete_sitemap>`.
112+
The `contents of the docs <users/index.html>`_.

‎doc/users/backmatter.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ Project information
66
:maxdepth: 1
77

88
license.rst
9-
../citing.rst
9+
citing.rst
1010
credits.rst
1111
history.rst

doc/citing.rst renamed to doc/users/citing.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
:orphan:
1+
.. redirect-from:: /citing
2+
23

34
Citing Matplotlib
45
=================

doc/faq/environment_variables_faq.rst renamed to doc/users/faq/environment_variables_faq.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
.. _environment-variables:
22

3+
.. redirect-from:: /faq/environment_variables_faq
4+
35
*********************
46
Environment variables
57
*********************

doc/faq/howto_faq.rst renamed to doc/users/faq/howto_faq.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
.. _howto-faq:
22

3+
.. redirect-from:: /faq/howto_faq
4+
35
******
46
How-to
57
******

doc/faq/index.rst renamed to doc/users/faq/index.rst

Lines changed: 5 additions & 3 deletions

0 commit comments

Comments
 (0)