File tree 2 files changed +27
-14
lines changed 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
138
138
It is useful to strive for consistency in the Matplotlib documentation. Here
139
139
are some formatting and style conventions that are used.
140
140
141
- Section name formatting
142
- ~~~~~~~~~~~~~~~~~~~~~~~
141
+ Section formatting
142
+ ~~~~~~~~~~~~~~~~~~
143
143
144
144
For everything but top-level chapters, use ``Upper lower `` for
145
145
section titles, e.g., ``Possible hangups `` rather than ``Possible
146
146
Hangups ``
147
147
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
+
148
163
Function arguments
149
164
~~~~~~~~~~~~~~~~~~
150
165
Original file line number Diff line number Diff line change 5
5
.. module :: matplotlib
6
6
7
7
8
+ ##################################
8
9
Matplotlib |release | documentation
9
- ----------------------------------
10
+ ##################################
10
11
11
12
Matplotlib is a comprehensive library for creating static, animated,
12
13
and interactive visualizations in Python.
13
14
15
+ ************
14
16
Installation
15
- ============
17
+ ************
16
18
17
19
.. container :: twocol
18
20
@@ -35,9 +37,9 @@ Installation
35
37
Further details are available in the :doc: `Installation Guide <users/installing/index >`.
36
38
37
39
40
+ ******************
38
41
Learning resources
39
- ==================
40
-
42
+ ******************
41
43
42
44
.. panels ::
43
45
@@ -81,26 +83,22 @@ Learning resources
81
83
82
84
83
85
86
+ ********************
84
87
Third-party packages
85
- --------------------
88
+ ********************
86
89
87
90
There are many `Third-party packages
88
91
<https://matplotlib.org/mpl-third-party/> `_ built on top of and extending
89
92
Matplotlib.
90
93
91
94
95
+ ************
92
96
Contributing
93
- ------------
97
+ ************
94
98
95
99
Matplotlib is a community project maintained for and by its users. There are many ways
96
100
you can help!
97
101
98
102
- Help other users `on discourse <https://discourse.matplotlib.org >`__
99
103
- report a bug or request a feature `on GitHub <https://github.com/matplotlib/matplotlib/issues >`__
100
104
- 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