@@ -399,11 +399,14 @@ expression in the Matplotlib figure. In these cases, you can use the
399
399
400
400
.. _writing-docstrings :
401
401
402
- Write docstrings
403
- ================
402
+ Write API documentation
403
+ =======================
404
404
405
- Most of the API documentation is written in docstrings. These are comment
406
- blocks in source code that explain how the code works.
405
+ The API reference documentation describes the library interfaces, e.g. inputs, outputs,
406
+ and expected behavior. Most of the API documentation is written in docstrings. These are
407
+ comment blocks in source code that explain how the code works. All docstrings should
408
+ conform to the `numpydoc docstring guide `_. Much of the ReST _ syntax discussed above
409
+ (:ref: `writing-rest-pages `) can be used for links and references.
407
410
408
411
.. note ::
409
412
@@ -412,11 +415,11 @@ blocks in source code that explain how the code works.
412
415
you may see in the source code. Pull requests updating docstrings to
413
416
the current style are very welcome.
414
417
415
- All new or edited docstrings should conform to the ` numpydoc docstring guide `_.
416
- Much of the ReST _ syntax discussed above ( :ref: ` writing-rest-pages `) can be
417
- used for links and references. These docstrings eventually populate the
418
- :file: `doc/api ` directory and form the reference documentation for the
419
- library.
418
+ The pages in :file: ` doc/api ` are purely technical definitions of
419
+ layout; therefore new API reference documentation should be added to the module
420
+ docstrings. This placement keeps all API reference documentation about a module in the
421
+ same file. These module docstrings eventually populate the :file: `doc/api ` directory
422
+ and form the reference documentation for the library.
420
423
421
424
Example docstring
422
425
-----------------
@@ -866,6 +869,26 @@ Plots can also be directly placed inside docstrings. Details are in
866
869
An advantage of this style over referencing an example script is that the
867
870
code will also appear in interactive docstrings.
868
871
872
+ .. _inheritance-diagrams :
873
+
874
+ Generate inheritance diagrams
875
+ -----------------------------
876
+
877
+ Class inheritance diagrams can be generated with the Sphinx
878
+ `inheritance-diagram `_ directive.
879
+
880
+ .. _inheritance-diagram : https://www.sphinx-doc.org/en/master/usage/extensions/inheritance.html
881
+
882
+ Example:
883
+
884
+ .. code-block :: rst
885
+
886
+ .. inheritance-diagram:: matplotlib.patches matplotlib.lines matplotlib.text
887
+ :parts: 2
888
+
889
+ .. inheritance-diagram :: matplotlib.patches matplotlib.lines matplotlib.text
890
+ :parts: 2
891
+
869
892
.. _writing-examples-and-tutorials :
870
893
871
894
Write examples and tutorials
@@ -1173,28 +1196,6 @@ Use the full path for this directive, relative to the doc root at
1173
1196
found by users at ``http://matplotlib.org/stable/old_topic/old_info2 ``.
1174
1197
For clarity, do not use relative links.
1175
1198
1176
-
1177
- .. _inheritance-diagrams :
1178
-
1179
- Generate inheritance diagrams
1180
- -----------------------------
1181
-
1182
- Class inheritance diagrams can be generated with the Sphinx
1183
- `inheritance-diagram `_ directive.
1184
-
1185
- .. _inheritance-diagram : https://www.sphinx-doc.org/en/master/usage/extensions/inheritance.html
1186
-
1187
- Example:
1188
-
1189
- .. code-block :: rst
1190
-
1191
- .. inheritance-diagram:: matplotlib.patches matplotlib.lines matplotlib.text
1192
- :parts: 2
1193
-
1194
- .. inheritance-diagram :: matplotlib.patches matplotlib.lines matplotlib.text
1195
- :parts: 2
1196
-
1197
-
1198
1199
Navbar and style
1199
1200
----------------
1200
1201
0 commit comments