Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

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

Sign up
Appearance settings

DOC: add API docs content guidelines to api docs instructions#30085

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
timhoffm merged 2 commits intomatplotlib:mainfromstory645:api-guidance
May 20, 2025
Merged
Changes from1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
PrevPrevious commit
move inheritance diagrams out of miscellanious to API
  • Loading branch information
@story645
story645 committedMay 20, 2025
commitc3987ee06745d15f0a35d33de7f40101c13e39fc
42 changes: 20 additions & 22 deletionsdoc/devel/document.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -869,6 +869,26 @@ Plots can also be directly placed inside docstrings. Details are in
An advantage of this style over referencing an example script is that the
code will also appear in interactive docstrings.

.. _inheritance-diagrams:

Generate inheritance diagrams
-----------------------------

Class inheritance diagrams can be generated with the Sphinx
`inheritance-diagram`_ directive.

.. _inheritance-diagram: https://www.sphinx-doc.org/en/master/usage/extensions/inheritance.html

Example:

.. code-block:: rst

.. inheritance-diagram:: matplotlib.patches matplotlib.lines matplotlib.text
:parts: 2

.. inheritance-diagram:: matplotlib.patches matplotlib.lines matplotlib.text
:parts: 2

.. _writing-examples-and-tutorials:

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


.. _inheritance-diagrams:

Generate inheritance diagrams
-----------------------------

Class inheritance diagrams can be generated with the Sphinx
`inheritance-diagram`_ directive.

.. _inheritance-diagram: https://www.sphinx-doc.org/en/master/usage/extensions/inheritance.html

Example:

.. code-block:: rst

.. inheritance-diagram:: matplotlib.patches matplotlib.lines matplotlib.text
:parts: 2

.. inheritance-diagram:: matplotlib.patches matplotlib.lines matplotlib.text
:parts: 2


Navbar and style
----------------

Expand Down

[8]ページ先頭

©2009-2025 Movatter.jp