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

Merge pull request #1934 from jpic/styleguide_link

Browse Source 
Link to Python's Style Guide for documentation.
This commit is contained in:
Takeshi KOMIYA
2016-01-11 01:38:45 +09:00
parent e4b9eb51f6 9265010609
commit 3ebee4d22d
1 changed files with 4 additions and 2 deletions
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