DOC: RST Titles Underline reordering (#21677)

* ~ not ^

* = skipped for -

* swap - and = underline in files they are swapped

* * to = in header underline

* - to = and * to - for consitency

* A few more change * -> ~

* use ~ instead of +

* DOC: Fixup `c-api/array.rst` with further ^ with ~ replacement

There is still a fourth level here, which remains using "

Co-authored-by: Sebastian Berg <sebastian@sipsolutions.net>

4 files changed, 33 insertions, 33 deletions

diff --git a/doc/source/dev/development_gitpod.rst b/doc/source/dev/development_gitpod.rst
index 92cca81fc..4e386867d 100644
--- a/doc/source/dev/development_gitpod.rst
+++ b/doc/source/dev/development_gitpod.rst
@@ -2,7 +2,7 @@
 
 
 Using Gitpod for NumPy development
-=======================================================
+==================================
 
 This section of the documentation will guide you through:
 
@@ -12,7 +12,7 @@ This section of the documentation will guide you through:
 *  working on the NumPy documentation in Gitpod
 
 Gitpod
--------
+------
 
 `Gitpod`_  is an open-source platform for automated and ready-to-code 
 development environments. It enables developers to describe their dev 
@@ -21,7 +21,7 @@ each new task directly from your browser. This reduces the need to install local
 development environments and deal with incompatible dependencies.
 
 Gitpod GitHub integration
---------------------------
+-------------------------
 
 To be able to use Gitpod, you will need to have the Gitpod app installed on your 
 GitHub account, so if
@@ -40,7 +40,7 @@ permissions later on. Click on the green **Install** button
 This will install the necessary hooks for the integration.
 
 Forking the NumPy repository
------------------------------
+----------------------------
 
 The best way to work on NumPy as a contributor is by making a fork of the 
 repository first.
@@ -50,7 +50,7 @@ repository first.
    https://github.com/melissawm/NumPy, except with your GitHub username in place of ``melissawm``.
 
 Starting Gitpod
-----------------
+---------------
 Once you have authenticated to Gitpod through GitHub, you can install the 
 `Gitpod browser extension <https://www.gitpod.io/docs/browser-extension>`_  
 which will add a **Gitpod** button next to the **Code** button in the 
@@ -86,7 +86,7 @@ of tests that make sure NumPy is working as it should, and ``-v`` activates the
 ``--verbose`` option to show all the test output.
 
 Quick workspace tour
----------------------
+--------------------
 Gitpod uses VSCode as the editor. If you have not used this editor before, you 
 can check the Getting started `VSCode docs`_ to familiarize yourself with it.
 
@@ -125,7 +125,7 @@ development experience:
 *  `VSCode Git Graph extension <https://marketplace.visualstudio.com/items?itemName=mhutchie.git-graph>`_
 
 Development workflow with Gitpod
----------------------------------
+--------------------------------
 The  :ref:`development-workflow` section of this documentation contains 
 information regarding the NumPy development workflow. Make sure to check this 
 before working on your contributions.
@@ -144,7 +144,7 @@ When using Gitpod, git is pre configured for you:
       :alt: Gitpod workspace branches plugin screenshot
 
 Rendering the NumPy documentation
-----------------------------------
+---------------------------------
 You can find the detailed documentation on how rendering the documentation with 
 Sphinx works in the :ref:`howto-build-docs` section.
 
@@ -153,7 +153,7 @@ this task is completed, you have two main options to render the documentation
 in Gitpod.
 
 Option 1: Using Liveserve
-***************************
+~~~~~~~~~~~~~~~~~~~~~~~~~
 
 #. View the documentation in ``NumPy/doc/build/html``. You can start with 
    ``index.html`` and browse, or you can jump straight to the file you're 
@@ -170,7 +170,7 @@ Option 1: Using Liveserve
 #. To stop the server click on the **Port: 5500** button on the status bar.
 
 Option 2: Using the rst extension
-***********************************
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 A quick and easy way to see live changes in a ``.rst`` file as you work on it 
 uses the rst extension with docutils.
@@ -200,13 +200,13 @@ FAQ's and troubleshooting
 -------------------------
 
 How long is my Gitpod workspace kept for?
-*****************************************
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Your stopped workspace will be kept for 14 days and deleted afterwards if you do 
 not use them.
 
 Can I come back to a previous workspace?
-*****************************************
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Yes, let's say you stepped away for a while and you want to carry on working on 
 your NumPy contributions. You need to visit https://gitpod.io/workspaces and 
@@ -214,13 +214,13 @@ click on the workspace you want to spin up again. All your changes will be there
 as you last left them.
 
 Can I install additional VSCode extensions?
-*******************************************
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Absolutely! Any extensions you installed will be installed in your own workspace 
 and preserved.
 
 I registered on Gitpod but I still cannot see a ``Gitpod`` button in my repositories.
-*************************************************************************************
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Head to https://gitpod.io/integrations and make sure you are logged in. 
 Hover over GitHub and click on the three buttons that appear on the right. 
@@ -232,14 +232,14 @@ and confirm the changes in the GitHub application page.
    :alt: Gitpod integrations - edit GH permissions screenshot
 
 How long does my workspace stay active if I'm not using it?
-***********************************************************
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 If you keep your workspace open in a browser tab but don't interact with it, 
 it will shut down after 30 minutes. If you close the browser tab, it will 
 shut down after 3 minutes.
 
 My terminal is blank - there is no cursor and it's completely unresponsive
-**************************************************************************
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Unfortunately this is a known-issue on Gitpod's side. You can sort this 
 issue in two ways:
@@ -254,7 +254,7 @@ issue in two ways:
    :alt: Gitpod dashboard and workspace menu screenshot
 
 I authenticated through GitHub but I still cannot commit to the repository through Gitpod. 
-******************************************************************************************
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Head to https://gitpod.io/integrations and make sure you are logged in. 
 Hover over GitHub and click on the three buttons that appear on the right. 
diff --git a/doc/source/dev/howto-docs.rst b/doc/source/dev/howto-docs.rst
index ff4a9f6d5..b30955e3e 100644
--- a/doc/source/dev/howto-docs.rst
+++ b/doc/source/dev/howto-docs.rst
@@ -252,7 +252,7 @@ existing non-indexed comment blocks.
 .. doxygenclass:: DoxyLimbo
 
 Common Doxygen Tags:
-++++++++++++++++++++
+~~~~~~~~~~~~~~~~~~~~
 
 .. note::
    For more tags/commands, please take a look at https://www.doxygen.nl/manual/commands.html
@@ -340,7 +340,7 @@ converting the documents generated by Doxygen_ into reST files.
    For more information, please check out "`Directives & Config Variables <https://breathe.readthedocs.io/en/latest/directives.html>`__"
 
 Common directives:
-++++++++++++++++++
+~~~~~~~~~~~~~~~~~~
 
 ``doxygenfunction``
 
diff --git a/doc/source/dev/howto_build_docs.rst b/doc/source/dev/howto_build_docs.rst
index 32a1f121d..02a8820c9 100644
--- a/doc/source/dev/howto_build_docs.rst
+++ b/doc/source/dev/howto_build_docs.rst
@@ -12,7 +12,7 @@ versions can be found at
 in several different formats.
 
 Development environments
-------------------------
+========================
 
 Before proceeding further it should be noted that the documentation is built with the ``make`` tool,
 which is not natively available on Windows. MacOS or Linux users can jump
@@ -22,7 +22,7 @@ for Linux (WSL) <https://docs.microsoft.com/en-us/windows/wsl/install-win10>`_.
 for a persistent local set-up.
 
 Gitpod
-^^^^^^
+~~~~~~
 Gitpod is an open-source platform that automatically creates the correct development environment right
 in your browser, reducing the need to install local development environments and deal with
 incompatible dependencies.
@@ -35,12 +35,12 @@ it is often faster to build with Gitpod. Here are the in-depth instructions for
 .. _how-todoc.prerequisites:
 
 Prerequisites
--------------
+=============
 
 Building the NumPy documentation and API reference requires the following:
 
 NumPy
-^^^^^
+~~~~~
 
 Since large parts of the main documentation are obtained from NumPy via
 ``import numpy`` and examining the docstrings, you will need to first
@@ -56,7 +56,7 @@ Alternatively, if using Python virtual environments (via e.g. ``conda``,
 new virtual environment is recommended.
 
 Dependencies
-^^^^^^^^^^^^
+~~~~~~~~~~~~
 
 All of the necessary dependencies for building the NumPy docs except for
 Doxygen_ can be installed with::
@@ -81,7 +81,7 @@ are using Linux then you can install it through your distribution package manage
    warnings during the build.
 
 Submodules
-^^^^^^^^^^
+~~~~~~~~~~
 
 If you obtained NumPy via git, also get the git submodules that contain
 additional parts required for building the documentation::
@@ -93,7 +93,7 @@ additional parts required for building the documentation::
 .. _Doxygen: https://www.doxygen.nl/index.html
 
 Instructions
-------------
+============
 
 Now you are ready to generate the docs, so write::
 
diff --git a/doc/source/dev/internals.code-explanations.rst b/doc/source/dev/internals.code-explanations.rst
index b6edd61b1..eaa629523 100644
--- a/doc/source/dev/internals.code-explanations.rst
+++ b/doc/source/dev/internals.code-explanations.rst
@@ -421,7 +421,7 @@ the 1-D loop is completed.
 
 
 One loop
-^^^^^^^^
+~~~~~~~~
 
 This is the simplest case of all. The ufunc is executed by calling the
 underlying 1-D loop exactly once. This is possible only when we have
@@ -434,7 +434,7 @@ complete.
 
 
 Strided loop
-^^^^^^^^^^^^
+~~~~~~~~~~~~
 
 When the input and output arrays are aligned and of the correct type,
 but the striding is not uniform (non-contiguous and 2-D or larger),
@@ -447,7 +447,7 @@ hardware error flags are checked after each 1-D loop is completed.
 
 
 Buffered loop
-^^^^^^^^^^^^^
+~~~~~~~~~~~~~
 
 This is the code that handles the situation whenever the input and/or
 output arrays are either misaligned or of the wrong datatype
@@ -514,7 +514,7 @@ objects have 0 and 1 elements respectively.
 
 
 Setup
-^^^^^
+~~~~~
 
 The setup function for all three methods is ``construct_reduce``.
 This function creates a reducing loop object and fills it with the
@@ -546,7 +546,7 @@ routine returns to the actual computation routine.
 
 
 :meth:`Reduce <ufunc.reduce>` 
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. index::
    triple: ufunc; methods; reduce
@@ -585,7 +585,7 @@ the loop function on chunks no greater than the user-specified
 
 
 :meth:`Accumulate <ufunc.accumulate>`
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. index::
    triple: ufunc; methods; accumulate
@@ -611,7 +611,7 @@ calling the underlying 1-D computational loop.
 
 
 :meth:`Reduceat <ufunc.reduceat>`
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. index::
    triple: ufunc; methods; reduceat