Skip to content

docs(CONTRIBUTING): define the section hierarchy #603

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
StaticRocket merged 1 commit into from
Dec 19, 2025
+29 −0
Merged

docs(CONTRIBUTING): define the section hierarchy #603

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,35 @@ in this case:
replace_b
```

### Headings / sections

We are trying to move to the [Python Developer's Guide for
documenting](https://devguide.python.org/documentation/markup/#sections)
standard of section hierarchy. This means that section definitions should use
the following pattern:

```rst
#########
Section 1
#########

*********
Section 2
*********

Section 3
=========

Section 4
---------

Section 5
^^^^^^^^^

Section 6
"""""""""
```

## Licensing

### Community
Expand Down