Update headings and underlines

python · ezio-melotti · Jul 11, 2022 · Jun 14, 2022 · Jun 15, 2022 · Jun 15, 2022
commit b960548236448d1758ec74a4aa26a1e6689c3a6c
diff --git a/advanced-tools/clang.rst b/advanced-tools/clang.rst
@@ -1,8 +1,8 @@
 .. _clang:
 
-***************************
+===========================
 Dynamic Analysis with Clang
-***************************
+===========================
 
 .. highlight:: bash
 

diff --git a/advanced-tools/gdb.rst b/advanced-tools/gdb.rst
@@ -1,6 +1,7 @@
 .. _gdb:
 
-gdb Support
+===========
+GDB Support
 ===========
 
 .. highlight:: none
@@ -17,7 +18,7 @@ limitation.
 
 
 gdb 7 and later
----------------
+===============
 
 In gdb 7, support for `extending gdb with Python
 <https://sourceware.org/gdb/current/onlinedocs/gdb/Python.html#Python>`_ was
@@ -300,7 +301,7 @@ thread is doing at the Python level::
 
 
 gdb 6 and earlier
------------------
+=================
 
 The file at ``Misc/gdbinit`` contains a gdb configuration file which provides
 extra commands when working with a CPython process. To register these commands
@@ -311,7 +312,7 @@ from your gdb session.
 
 
 Updating auto-load-safe-path to allow test_gdb to run
------------------------------------------------------
+=====================================================
 
 ``test_gdb`` attempts to automatically load additional Python specific
 hooks into gdb in order to test them. Unfortunately, the command line

diff --git a/core-developers/become-core-developer.rst b/core-developers/become-core-developer.rst
@@ -1,8 +1,8 @@
 .. _coredev:
 
-================================
- How to Become a Core Developer
-================================
+==============================
+How to Become a Core Developer
+==============================
 
 What it Takes
 =============

diff --git a/core-developers/experts.rst b/core-developers/experts.rst
@@ -1,5 +1,6 @@
 .. _experts:
 
+=============
 Experts Index
 =============
 
@@ -44,7 +45,8 @@ not feel qualified to make a decision in a particular context.
 
 
 Stdlib
-------
+======
+
 ====================  =============================================
 Module                Maintainers
 ====================  =============================================
@@ -276,7 +278,8 @@ zlib                  Yhg1s, gpshead*
 
 
 Tools
------
+=====
+
 ==================  ===========
 Tool                Maintainers
 ==================  ===========
@@ -286,7 +289,8 @@ PEG Generator       gvanrossum, pablogsal, lysnikolaou
 
 
 Platforms
----------
+=========
+
 ===================   ===========
 Platform              Maintainers
 ===================   ===========
@@ -305,7 +309,8 @@ JVM/Java              frank.wierzbicki^
 
 
 Miscellaneous
--------------
+=============
+
 ==================  ==========================================================
 Interest Area       Maintainers
 ==================  ==========================================================
@@ -359,6 +364,6 @@ version control     merwok, ezio-melotti
 
 
 Documentation Translations
---------------------------
+==========================
 
 For a list of translators, see :ref:`this table about translations <translating>`.
diff --git a/core-developers/motivations.rst b/core-developers/motivations.rst
@@ -1,7 +1,8 @@
 .. _motivations:
 
-Core Developer Motivations and Affiliations
-===========================================
+============================
+Motivations and Affiliations
+============================
 
 CPython core developers participate in the core development process for a
 variety of reasons. Being accepted as a core developer indicates that
@@ -29,7 +30,7 @@ For more information on the origins and purpose of this page, see
 .. _published-motivations:
 
 Published entries
------------------
+=================
 
 The following core developers have chosen to provide additional details
 regarding their professional affiliations and (optionally) other reasons for
@@ -270,7 +271,7 @@ participating in the CPython core development process:
 .. _goals-of-the-motivations-page:
 
 Goals of this page
-------------------
+==================
 
 The `issue metrics`_ automatically collected by the CPython issue tracker
 strongly suggest that the current core development process is bottlenecked on
@@ -329,7 +330,7 @@ time contributing to CPython development.
 
 
 Limitations on scope
---------------------
+====================
 
 * Specific technical areas of interest for core developers should be captured in
   the :ref:`Experts Index <experts>`.

diff --git a/developer-workflow/communication-channels.rst b/developer-workflow/communication-channels.rst
@@ -1,5 +1,6 @@
 .. _communication:
 
+==============================
 Following Python's Development
 ==============================
 
@@ -8,7 +9,8 @@ mailing lists, but also other forms.
 
 
 Standards of behaviour in these communication channels
-------------------------------------------------------
+======================================================
+
 We try to foster environments of mutual respect, tolerance and encouragement,
 as described in the PSF's `Diversity Statement`_. Abiding by the guidelines
 in this document and asking questions or posting suggestions in the
@@ -22,7 +24,7 @@ in return.
 .. _mailinglists:
 
 Mailing Lists
--------------
+=============
 
 python-dev_ is the primary mailing list for discussions about Python's
 development. The list is open to the public and is subscribed to by all core
@@ -95,7 +97,7 @@ RSS feed readers.
 .. _discourse_discuss:
 
 Discourse (discuss.python.org web forum)
-----------------------------------------
+========================================
 
 We have our own `Discourse`_ forum for both developers and users. This forum
 complements the `python-dev`_, `python-ideas`_, `python-help`_, and
@@ -113,7 +115,8 @@ It is also a common venue for the core developer promotion votes (this
 category is equivalent to the python-committers mailing list).
 
 Tutorials for new users
-'''''''''''''''''''''''
+-------------------------
+
 To start a topic or participate in any discussions in the forum, sign up and
 create an account using an email address or GitHub account. You can do so by
 clicking the "Sign Up" button on the top right hand corner of the `Discourse`_
@@ -144,7 +147,7 @@ dots under the message and then on the ⚐ icon.  You can also mention the
 
 
 Reading topics
-'''''''''''''''
+-----------------
 Click a topic title and read down the list of replies in chronological order,
 following links or previewing replies and quotes as you go. Use your mouse to
 scroll the screen, or use the timeline scroll bar on the right which also shows
@@ -153,10 +156,11 @@ bottom progress bar to expand it.
 
 
 Notifications
-'''''''''''''
+-------------
 
 Following categories (Category notifications)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+'''''''''''''''''''''''''''''''''''''''''''''
+
 Notifications can be set for individual categories and topics. To change any of these
 defaults, you can either go to your user preferences, or visit the category
 page, and use the notification button 🔔 above the topic list,
@@ -168,21 +172,24 @@ All categories are set by default in Normal mode where you will only be notified
 if someone mentions your @name or replies to you.
 
 Following individual threads (Topic notifications)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+''''''''''''''''''''''''''''''''''''''''''''''''''
+
 To follow any individual topics or threads, you can adjust your notifications
 through the notification button 🔔 found on the right of the topic at the end
 of the timeline. You can also do so at the bottom of each topic.
 Select "Watching" and you will be notified when there is any new updated reply
 from that particular thread.
 
 Customising notifications on user preference
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+''''''''''''''''''''''''''''''''''''''''''''
+
 To get a bird's eye view of all your customised notifications, you can
 go to `Preferences of your account <https://discuss.python.org/my/preferences/categories>`_.
 This allows you to make adjustments according to categories, users, and tags.
 
 Enabling mailing list mode
-''''''''''''''''''''''''''
+--------------------------
+
 In mailing list mode, you will receive one email per post, as happens with
 traditional mailing lists. This is desirable if you prefer to interact via email,
 without visiting the forum website.
@@ -197,7 +204,7 @@ mailing list mode" and save changes.
 
 
 Discord (private chat server)
------------------------------
+=============================
 
 For more real-time discussions, the core development team have a private Discord
 server available. Core developers, Steering Council members, triagers, and
@@ -235,7 +242,7 @@ set a specific `Server Nickname`_
 
 
 IRC
----
+===
 
 Some core developers still participate in the ``#python-dev`` IRC channel on
 ``irc.libera.chat``. This is not a place to ask for help with Python, but to
@@ -244,23 +251,23 @@ discuss issues related to Python's own development. See also the
 
 
 Blogs
------
+=====
 
 Several core developers are active bloggers and discuss Python's development
 that way. You can find their blogs (and various other developers who use Python)
 at https://planetpython.org/.
 
 
 Setting Expectations for Open Source Participation
---------------------------------------------------
+==================================================
 
 Burn-out is common in open source due to a misunderstanding of what users, contributors,
 and maintainers should expect from each other. Brett Cannon gave a `talk <https://www.youtube.com/watch?v=-Nk-8fSJM6I>`_
 about this topic that sets out to help everyone set reasonable expectations of each other in
 order to make open source pleasant for everyone involved.
 
 Additional Repositories
------------------------
+=======================
 
 `Python Core Workflow`_ hosts the codebase for tools such as `cherry_picker`_
 and `blurb`_.

diff --git a/developer-workflow/extension-modules.rst b/developer-workflow/extension-modules.rst
@@ -1,7 +1,8 @@
 .. _extensions:
 
-Updating standard library extension modules
-===========================================
+==================================
+Standard Library Extension Modules
+==================================
 
 In this section, we could explain how to write a CPython extension with the C language, but the topic can take a complete book.
 

diff --git a/developer-workflow/grammar.rst b/developer-workflow/grammar.rst
@@ -1,10 +1,11 @@
 .. _grammar:
 
+==========================
 Changing CPython's Grammar
 ==========================
 
 Abstract
---------
+========
 
 There's more to changing Python's grammar than editing
 :file:`Grammar/python.gram`.  Here's a checklist.
@@ -20,7 +21,7 @@ For more information on how to use the new parser, check the
 :ref:`section on how to use CPython's parser <parser>`.
 
 Checklist
----------
+=========
 
 Note: sometimes things mysteriously don't work.  Before giving up, try ``make clean``.
 

diff --git a/developer-workflow/porting.rst b/developer-workflow/porting.rst
@@ -1,7 +1,8 @@
 .. _porting:
 
-Porting Python to a new platform
---------------------------------
+=========================
+Porting to a New Platform
+=========================
 
 The first step is to familiarize yourself with the development toolchain on
 the platform in question, notably the C compiler. Make sure you can compile and

diff --git a/documentation/help-documenting.rst b/documentation/help-documenting.rst
@@ -1,5 +1,6 @@
 .. _docquality:
 
+==========================
 Helping with Documentation
 ==========================
 
@@ -20,7 +21,7 @@ detailed information on how to write documentation and submit changes.
 
 
 Python Documentation
---------------------
+====================
 
 The :ref:`Documenting Python <documenting>` section covers the details of how
 Python's documentation works. It includes information about the markup
@@ -43,7 +44,7 @@ mailing list discusses the documentation toolchain, projects, and standards.
 
 
 Helping with documentation issues
----------------------------------
+=================================
 
 If you look at `documentation issues`_ on the `issue tracker`_, you
 will find various documentation problems that may need work. Issues vary from
@@ -67,7 +68,7 @@ you will learn the workflow for documentation pull requests.
 
 
 Proofreading
-------------
+============
 
 While an issue filed on the `issue tracker`_ means there is a known issue
 somewhere, that does not mean there are not other issues lurking about in the

diff --git a/documentation/start-documenting.rst b/documentation/start-documenting.rst
@@ -1,8 +1,8 @@
 .. _documenting:
 
-==================
-Documenting Python
-==================
+===============
+Getting Started
+===============
 
 .. highlight::  rest
 

diff --git a/getting-started/fixing-issues.rst b/getting-started/fixing-issues.rst
@@ -1,5 +1,6 @@
 .. _fixingissues:
 
+=================================
 Fixing "easy" Issues (and Beyond)
 =================================