Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 31ab052

Browse files
committed
move inheritance diagrams out of miscellanious to API
1 parent 63417da commit 31ab052

File tree

1 file changed

+21
-23
lines changed

1 file changed

+21
-23
lines changed

doc/devel/document.rst

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -405,7 +405,7 @@ Write API documentation
405405
The API reference documentation describes the library interfaces, e.g. inputs, outputs,
406406
and expected behavior. Most of the API documentation is written in docstrings. These are
407407
comment blocks in source code that explain how the code works. All new or edited
408-
ocstrings should conform to the `numpydoc docstring guide`_. Much of the ReST_ syntax
408+
docstrings should conform to the `numpydoc docstring guide`_. Much of the ReST_ syntax
409409
discussed above (:ref:`writing-rest-pages`) can be used for links and references.
410410

411411
.. note::
@@ -869,6 +869,26 @@ Plots can also be directly placed inside docstrings. Details are in
869869
An advantage of this style over referencing an example script is that the
870870
code will also appear in interactive docstrings.
871871

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+
872892
.. _writing-examples-and-tutorials:
873893

874894
Write examples and tutorials
@@ -1154,28 +1174,6 @@ Use the full path for this directive, relative to the doc root at
11541174
found by users at ``http://matplotlib.org/stable/old_topic/old_info2``.
11551175
For clarity, do not use relative links.
11561176

1157-
1158-
.. _inheritance-diagrams:
1159-
1160-
Generate inheritance diagrams
1161-
-----------------------------
1162-
1163-
Class inheritance diagrams can be generated with the Sphinx
1164-
`inheritance-diagram`_ directive.
1165-
1166-
.. _inheritance-diagram: https://www.sphinx-doc.org/en/master/usage/extensions/inheritance.html
1167-
1168-
Example:
1169-
1170-
.. code-block:: rst
1171-
1172-
.. inheritance-diagram:: matplotlib.patches matplotlib.lines matplotlib.text
1173-
:parts: 2
1174-
1175-
.. inheritance-diagram:: matplotlib.patches matplotlib.lines matplotlib.text
1176-
:parts: 2
1177-
1178-
11791177
Navbar and style
11801178
----------------
11811179

0 commit comments

Comments
 (0)