Skip to content

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit c3987ee

Browse filesBrowse files
committed
move inheritance diagrams out of miscellanious to API
1 parent a3782cd commit c3987ee
Copy full SHA for c3987ee

File tree

1 file changed

+20
-22
lines changed
Filter options

1 file changed

+20
-22
lines changed

‎doc/devel/document.rst

Copy file name to clipboardExpand all lines: doc/devel/document.rst
+20-22Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -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 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.