File tree Expand file tree Collapse file tree 2 files changed +27
-14
lines changed Expand file tree Collapse file tree 2 files changed +27
-14
lines changed Original file line number Diff line number Diff line change @@ -138,13 +138,28 @@ Formatting and style conventions
138138It is useful to strive for consistency in the Matplotlib documentation. Here
139139are some formatting and style conventions that are used.
140140
141- Section name formatting
142- ~~~~~~~~~~~~~~~~~~~~~~~
141+ Section formatting
142+ ~~~~~~~~~~~~~~~~~~
143143
144144For everything but top-level chapters, use ``Upper lower `` for
145145section titles, e.g., ``Possible hangups `` rather than ``Possible
146146Hangups ``
147147
148+ We aim to follow the recommendations from the
149+ `Python documentation <https://devguide.python.org/documenting/#sections >`_
150+ and the `Sphinx reStructuredText documentation <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections >`_
151+ for section markup characters, i.e.:
152+
153+ - ``# `` with overline, for parts. This is reserved for the main title in
154+ ``index.rst ``. All other pages should start with "chapter" or lower.
155+ - ``* `` with overline, for chapters
156+ - ``= ``, for sections
157+ - ``- ``, for subsections
158+ - ``^ ``, for subsubsections
159+ - ``" ``, for paragraphs
160+
161+ This may not yet be applied consistently in existing docs.
162+
148163Function arguments
149164~~~~~~~~~~~~~~~~~~
150165
Original file line number Diff line number Diff line change 55.. module :: matplotlib
66
77
8+ ##################################
89Matplotlib |release | documentation
9- ----------------------------------
10+ ##################################
1011
1112Matplotlib is a comprehensive library for creating static, animated,
1213and interactive visualizations in Python.
1314
15+ ************
1416Installation
15- ============
17+ ************
1618
1719.. container :: twocol
1820
@@ -35,9 +37,9 @@ Installation
3537 Further details are available in the :doc: `Installation Guide <users/installing/index >`.
3638
3739
40+ ******************
3841Learning resources
39- ==================
40-
42+ ******************
4143
4244.. panels ::
4345
@@ -81,26 +83,22 @@ Learning resources
8183
8284
8385
86+ ********************
8487Third-party packages
85- --------------------
88+ ********************
8689
8790There are many `Third-party packages
8891<https://matplotlib.org/mpl-third-party/> `_ built on top of and extending
8992Matplotlib.
9093
9194
95+ ************
9296Contributing
93- ------------
97+ ************
9498
9599Matplotlib is a community project maintained for and by its users. There are many ways
96100you can help!
97101
98102- Help other users `on discourse <https://discourse.matplotlib.org >`__
99103- report a bug or request a feature `on GitHub <https://github.com/matplotlib/matplotlib/issues >`__
100104- or improve the :ref: `documentation and code <developers-guide-index >`
101-
102-
103- Users guide
104- -----------
105-
106- The `contents of the docs <users/index.html >`_.
You can’t perform that action at this time.
0 commit comments