Merge pull request #22117 from melissawm/user-guide-outline

DOC: Reorganize user guide outline
numpy · Aug 19, 2022 · f04f803 · f04f803
2 parents 831c04a + 31e1521
commit f04f803
Show file tree

Hide file tree

Showing 8 changed files with 29 additions and 32 deletions.
diff --git a/doc/source/bugs.rst b/doc/source/bugs.rst
diff --git a/doc/source/user/depending_on_numpy.rst → doc/source/dev/depending_on_numpy.rst b/doc/source/user/depending_on_numpy.rst → doc/source/dev/depending_on_numpy.rst
diff --git a/doc/source/dev/index.rst b/doc/source/dev/index.rst
@@ -265,6 +265,7 @@ The rest of the story
    reviewer_guidelines
    ../benchmarking
    NumPy C style guide <https://numpy.org/neps/nep-0045-c_style_guide.html>
+   depending_on_numpy
    releasing
    governance/index
    howto-docs

diff --git a/doc/source/dev/underthehood.rst b/doc/source/dev/underthehood.rst
@@ -1,7 +1,7 @@
 .. _underthehood:
 
 ===========================================
-Under-the-hood Documentation for developers
+Under-the-hood documentation for developers
 ===========================================
 
 These documents are intended as a low-level look into NumPy; focused
@@ -13,3 +13,7 @@ towards developers.
    internals
    internals.code-explanations
    alignment
+   ../user/byteswapping
+   ../user/basics.dispatch
+   ../user/basics.subclassing
+
diff --git a/doc/source/user/basics.rst b/doc/source/user/basics.rst
@@ -14,10 +14,6 @@ fundamental NumPy ideas and philosophy.
    basics.io
    basics.types
    basics.broadcasting
-   basics.byteswapping
+   basics.copies
    basics.rec
-   basics.dispatch
-   basics.subclassing
    basics.ufuncs
-   basics.copies
-   basics.interoperability
diff --git a/doc/source/user/basics.byteswapping.rst → doc/source/user/byteswapping.rst b/doc/source/user/basics.byteswapping.rst → doc/source/user/byteswapping.rst
diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst
@@ -8,21 +8,36 @@ This guide is an overview and explains the important features;
 details are found in :ref:`reference`.
 
 .. toctree::
+   :caption: Getting started
    :maxdepth: 1
 
    whatisnumpy
    Installation <https://numpy.org/install/>
    quickstart
    absolute_beginners
+
+.. toctree::
+   :caption: Fundamentals and usage
+   :maxdepth: 2
+
    basics
-   misc
+
+.. toctree::
+   :maxdepth: 1
+
    numpy-for-matlab-users
-   building
-   c-info
    NumPy Tutorials <https://numpy.org/numpy-tutorials/features.html>
    howtos_index
-   depending_on_numpy
 
+.. toctree::
+   :caption: Advanced usage and interoperability
+   :maxdepth: 1
+
+   building
+   c-info
+   ../f2py/index
+   ../dev/underthehood
+   basics.interoperability
 
 .. Links to these files are placed directly in the top-level html
    (doc/source/_templates/indexcontent.html, which appears for the URLs
@@ -32,10 +47,8 @@ details are found in :ref:`reference`.
 
 .. toctree::
    :hidden:
+   :caption: Extras
 
-   ../f2py/index
    ../glossary
-   ../dev/underthehood
-   ../bugs
    ../release
    ../license
diff --git a/doc/source/user/misc.rst b/doc/source/user/misc.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 *************
 Miscellaneous
 *************