Skip to content

Commit ce0c44f

Browse files
AA-Turnerezio-melotti
authored andcommitted
Update headings and underlines
1 parent 240cf8a commit ce0c44f

27 files changed

+222
-191
lines changed

advanced-tools/clang.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _clang:
22

3-
***************************
3+
===========================
44
Dynamic Analysis with Clang
5-
***************************
5+
===========================
66

77
.. highlight:: bash
88

advanced-tools/gdb.rst

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
.. _gdb:
22

3-
gdb Support
3+
===========
4+
GDB Support
45
===========
56

67
.. highlight:: none
@@ -17,7 +18,7 @@ limitation.
1718

1819

1920
gdb 7 and later
20-
---------------
21+
===============
2122

2223
In gdb 7, support for `extending gdb with Python
2324
<https://sourceware.org/gdb/current/onlinedocs/gdb/Python.html#Python>`_ was
@@ -300,7 +301,7 @@ thread is doing at the Python level::
300301

301302

302303
gdb 6 and earlier
303-
-----------------
304+
=================
304305

305306
The file at ``Misc/gdbinit`` contains a gdb configuration file which provides
306307
extra commands when working with a CPython process. To register these commands
@@ -311,7 +312,7 @@ from your gdb session.
311312

312313

313314
Updating auto-load-safe-path to allow test_gdb to run
314-
-----------------------------------------------------
315+
=====================================================
315316

316317
``test_gdb`` attempts to automatically load additional Python specific
317318
hooks into gdb in order to test them. Unfortunately, the command line

core-developers/become-core-developer.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _coredev:
22

3-
================================
4-
How to Become a Core Developer
5-
================================
3+
==============================
4+
How to Become a Core Developer
5+
==============================
66

77
What it Takes
88
=============

core-developers/experts.rst

+10-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
.. _experts:
22

3+
=============
34
Experts Index
45
=============
56

@@ -44,7 +45,8 @@ not feel qualified to make a decision in a particular context.
4445

4546

4647
Stdlib
47-
------
48+
======
49+
4850
==================== =============================================
4951
Module Maintainers
5052
==================== =============================================
@@ -276,7 +278,8 @@ zlib Yhg1s, gpshead*
276278

277279

278280
Tools
279-
-----
281+
=====
282+
280283
================== ===========
281284
Tool Maintainers
282285
================== ===========
@@ -286,7 +289,8 @@ PEG Generator gvanrossum, pablogsal, lysnikolaou
286289

287290

288291
Platforms
289-
---------
292+
=========
293+
290294
=================== ===========
291295
Platform Maintainers
292296
=================== ===========
@@ -305,7 +309,8 @@ JVM/Java frank.wierzbicki^
305309

306310

307311
Miscellaneous
308-
-------------
312+
=============
313+
309314
================== ==========================================================
310315
Interest Area Maintainers
311316
================== ==========================================================
@@ -359,6 +364,6 @@ version control merwok, ezio-melotti
359364

360365

361366
Documentation Translations
362-
--------------------------
367+
==========================
363368

364369
For a list of translators, see :ref:`this table about translations <translating>`.

core-developers/motivations.rst

+6-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
.. _motivations:
22

3-
Core Developer Motivations and Affiliations
4-
===========================================
3+
============================
4+
Motivations and Affiliations
5+
============================
56

67
CPython core developers participate in the core development process for a
78
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
2930
.. _published-motivations:
3031

3132
Published entries
32-
-----------------
33+
=================
3334

3435
The following core developers have chosen to provide additional details
3536
regarding their professional affiliations and (optionally) other reasons for
@@ -270,7 +271,7 @@ participating in the CPython core development process:
270271
.. _goals-of-the-motivations-page:
271272

272273
Goals of this page
273-
------------------
274+
==================
274275

275276
The `issue metrics`_ automatically collected by the CPython issue tracker
276277
strongly suggest that the current core development process is bottlenecked on
@@ -329,7 +330,7 @@ time contributing to CPython development.
329330

330331

331332
Limitations on scope
332-
--------------------
333+
====================
333334

334335
* Specific technical areas of interest for core developers should be captured in
335336
the :ref:`Experts Index <experts>`.

developer-workflow/communication-channels.rst

+22-15
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
.. _communication:
22

3+
==============================
34
Following Python's Development
45
==============================
56

@@ -8,7 +9,8 @@ mailing lists, but also other forms.
89

910

1011
Standards of behaviour in these communication channels
11-
------------------------------------------------------
12+
======================================================
13+
1214
We try to foster environments of mutual respect, tolerance and encouragement,
1315
as described in the PSF's `Diversity Statement`_. Abiding by the guidelines
1416
in this document and asking questions or posting suggestions in the
@@ -22,7 +24,7 @@ in return.
2224
.. _mailinglists:
2325

2426
Mailing Lists
25-
-------------
27+
=============
2628

2729
python-dev_ is the primary mailing list for discussions about Python's
2830
development. The list is open to the public and is subscribed to by all core
@@ -95,7 +97,7 @@ RSS feed readers.
9597
.. _discourse_discuss:
9698

9799
Discourse (discuss.python.org web forum)
98-
----------------------------------------
100+
========================================
99101

100102
We have our own `Discourse`_ forum for both developers and users. This forum
101103
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
113115
category is equivalent to the python-committers mailing list).
114116

115117
Tutorials for new users
116-
'''''''''''''''''''''''
118+
-------------------------
119+
117120
To start a topic or participate in any discussions in the forum, sign up and
118121
create an account using an email address or GitHub account. You can do so by
119122
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
144147

145148

146149
Reading topics
147-
'''''''''''''''
150+
-----------------
148151
Click a topic title and read down the list of replies in chronological order,
149152
following links or previewing replies and quotes as you go. Use your mouse to
150153
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.
153156

154157

155158
Notifications
156-
'''''''''''''
159+
-------------
157160

158161
Following categories (Category notifications)
159-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
162+
'''''''''''''''''''''''''''''''''''''''''''''
163+
160164
Notifications can be set for individual categories and topics. To change any of these
161165
defaults, you can either go to your user preferences, or visit the category
162166
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
168172
if someone mentions your @name or replies to you.
169173

170174
Following individual threads (Topic notifications)
171-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
175+
''''''''''''''''''''''''''''''''''''''''''''''''''
176+
172177
To follow any individual topics or threads, you can adjust your notifications
173178
through the notification button 🔔 found on the right of the topic at the end
174179
of the timeline. You can also do so at the bottom of each topic.
175180
Select "Watching" and you will be notified when there is any new updated reply
176181
from that particular thread.
177182

178183
Customising notifications on user preference
179-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
184+
''''''''''''''''''''''''''''''''''''''''''''
185+
180186
To get a bird's eye view of all your customised notifications, you can
181187
go to `Preferences of your account <https://discuss.python.org/my/preferences/categories>`_.
182188
This allows you to make adjustments according to categories, users, and tags.
183189

184190
Enabling mailing list mode
185-
''''''''''''''''''''''''''
191+
--------------------------
192+
186193
In mailing list mode, you will receive one email per post, as happens with
187194
traditional mailing lists. This is desirable if you prefer to interact via email,
188195
without visiting the forum website.
@@ -197,7 +204,7 @@ mailing list mode" and save changes.
197204

198205

199206
Discord (private chat server)
200-
-----------------------------
207+
=============================
201208

202209
For more real-time discussions, the core development team have a private Discord
203210
server available. Core developers, Steering Council members, triagers, and
@@ -235,7 +242,7 @@ set a specific `Server Nickname`_
235242

236243

237244
IRC
238-
---
245+
===
239246

240247
Some core developers still participate in the ``#python-dev`` IRC channel on
241248
``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
244251

245252

246253
Blogs
247-
-----
254+
=====
248255

249256
Several core developers are active bloggers and discuss Python's development
250257
that way. You can find their blogs (and various other developers who use Python)
251258
at https://planetpython.org/.
252259

253260

254261
Setting Expectations for Open Source Participation
255-
--------------------------------------------------
262+
==================================================
256263

257264
Burn-out is common in open source due to a misunderstanding of what users, contributors,
258265
and maintainers should expect from each other. Brett Cannon gave a `talk <https://www.youtube.com/watch?v=-Nk-8fSJM6I>`_
259266
about this topic that sets out to help everyone set reasonable expectations of each other in
260267
order to make open source pleasant for everyone involved.
261268

262269
Additional Repositories
263-
-----------------------
270+
=======================
264271

265272
`Python Core Workflow`_ hosts the codebase for tools such as `cherry_picker`_
266273
and `blurb`_.

developer-workflow/extension-modules.rst

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
.. _extensions:
22

3-
Updating standard library extension modules
4-
===========================================
3+
==================================
4+
Standard Library Extension Modules
5+
==================================
56

67
In this section, we could explain how to write a CPython extension with the C language, but the topic can take a complete book.
78

developer-workflow/grammar.rst

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
.. _grammar:
22

3+
==========================
34
Changing CPython's Grammar
45
==========================
56

67
Abstract
7-
--------
8+
========
89

910
There's more to changing Python's grammar than editing
1011
:file:`Grammar/python.gram`. Here's a checklist.
@@ -20,7 +21,7 @@ For more information on how to use the new parser, check the
2021
:ref:`section on how to use CPython's parser <parser>`.
2122

2223
Checklist
23-
---------
24+
=========
2425

2526
Note: sometimes things mysteriously don't work. Before giving up, try ``make clean``.
2627

developer-workflow/porting.rst

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
.. _porting:
22

3-
Porting Python to a new platform
4-
--------------------------------
3+
=========================
4+
Porting to a New Platform
5+
=========================
56

67
The first step is to familiarize yourself with the development toolchain on
78
the platform in question, notably the C compiler. Make sure you can compile and

documentation/help-documenting.rst

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
.. _docquality:
22

3+
==========================
34
Helping with Documentation
45
==========================
56

@@ -20,7 +21,7 @@ detailed information on how to write documentation and submit changes.
2021

2122

2223
Python Documentation
23-
--------------------
24+
====================
2425

2526
The :ref:`Documenting Python <documenting>` section covers the details of how
2627
Python's documentation works. It includes information about the markup
@@ -43,7 +44,7 @@ mailing list discusses the documentation toolchain, projects, and standards.
4344

4445

4546
Helping with documentation issues
46-
---------------------------------
47+
=================================
4748

4849
If you look at `documentation issues`_ on the `issue tracker`_, you
4950
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.
6768

6869

6970
Proofreading
70-
------------
71+
============
7172

7273
While an issue filed on the `issue tracker`_ means there is a known issue
7374
somewhere, that does not mean there are not other issues lurking about in the

documentation/start-documenting.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _documenting:
22

3-
==================
4-
Documenting Python
5-
==================
3+
===============
4+
Getting Started
5+
===============
66

77
.. highlight:: rest
88

getting-started/fixing-issues.rst

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
.. _fixingissues:
22

3+
=================================
34
Fixing "easy" Issues (and Beyond)
45
=================================
56

0 commit comments

Comments
 (0)