Skip to content

Commit da95649

Browse files
committed
docs(CONTRIBUTING): define the section hierarchy
Define the recommended section hierarchy in this guide so we have a quick ref to direct people to. Additionally, keep the link to the Python Developer's Guide since they have an excellent overview of RST that people just getting started should consider looking at. Signed-off-by: Randolph Sapp <[email protected]>
1 parent 8e9cda0 commit da95649

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

CONTRIBUTING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,35 @@ in this case:
164164
replace_b
165165
```
166166

167+
### Headings / sections
168+
169+
We are trying to move to the [Python Developer's Guide for
170+
documenting](https://devguide.python.org/documentation/markup/#sections)
171+
standard of section hierarchy. This means that section definitions should use
172+
the following pattern:
173+
174+
```rst
175+
#########
176+
Section 1
177+
#########
178+
179+
*********
180+
Section 2
181+
*********
182+
183+
Section 3
184+
=========
185+
186+
Section 4
187+
---------
188+
189+
Section 5
190+
^^^^^^^^^
191+
192+
Section 6
193+
"""""""""
194+
```
195+
167196
## Licensing
168197

169198
### Community

0 commit comments

Comments
 (0)