IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Link to Python's Style Guide for documentation.

Browse Source 
This is a follow-up to #1931
This commit is contained in:
jpic 2015-06-18 00:44:35 +02:00
parent 27be6614f7
commit 9265010609
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/rest.rst
View File

@ -223,8 +223,10 @@ as long as the text::
=================
Normally, there are no heading levels assigned to certain characters as the
structure is determined from the succession of headings. However, for the
Python documentation, this convention is used which you may follow:
structure is determined from the succession of headings. However, this
convention is used in `Python's Style Guide for documentating
<https://docs.python.org/devguide/documenting.html#style-guide>`_ which you may
follow:
* ``#`` with overline, for parts
* ``*`` with overline, for chapters