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
Appearance settings

Commit 6072c91

Browse filesBrowse files
anntzeranntzer
committed
Move plot_directive doc to main API index.
Sure, it's mostly for devs, but there's plenty of things in the API index that are for mostly devs too, so move it there.
1 parent 512aecb commit 6072c91
Copy full SHA for 6072c91

File tree

Expand file treeCollapse file tree

6 files changed

+10
-9
lines changed
Filter options
Expand file treeCollapse file tree

6 files changed

+10
-9
lines changed

‎doc/api/index.rst

Copy file name to clipboardExpand all lines: doc/api/index.rst
+1Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,7 @@ Matplotlib consists of the following submodules:
115115
rcsetup_api.rst
116116
sankey_api.rst
117117
scale_api.rst
118+
sphinxext_plot_directive_api.rst
118119
spines_api.rst
119120
style_api.rst
120121
table_api.rst

‎doc/api/sphinxext_plot_directive_api.rst

Copy file name to clipboard
+6Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
=======================================
2+
``matplotlib.sphinxext.plot_directive``
3+
=======================================
4+
5+
.. automodule:: matplotlib.sphinxext.plot_directive
6+
:no-undoc-members:

‎doc/devel/documenting_mpl.rst

Copy file name to clipboardExpand all lines: doc/devel/documenting_mpl.rst
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -678,7 +678,7 @@ Note that ``examples/text_labels_and_annotations/legend.py`` has been mapped to
678678
fixed in future re-organization of the docs.
679679

680680
Plots can also be directly placed inside docstrings. Details are in
681-
:doc:`/devel/plot_directive`. A short example is:
681+
:doc:`/api/sphinxext_plot_directive_api`. A short example is:
682682

683683
.. code-block:: python
684684

‎doc/devel/index.rst

Copy file name to clipboardExpand all lines: doc/devel/index.rst
-1Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ The Matplotlib Developers' Guide
1515
contributing.rst
1616
testing.rst
1717
documenting_mpl.rst
18-
plot_directive.rst
1918
add_new_projection.rst
2019
gitwash/index.rst
2120
coding_guide.rst

‎doc/devel/plot_directive.rst

Copy file name to clipboardExpand all lines: doc/devel/plot_directive.rst
-6Lines changed: 0 additions & 6 deletions
This file was deleted.

‎lib/matplotlib/sphinxext/plot_directive.py

Copy file name to clipboardExpand all lines: lib/matplotlib/sphinxext/plot_directive.py
+2-1Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
"""
2-
A directive for including a matplotlib plot in a Sphinx document.
2+
A directive for including a Matplotlib plot in a Sphinx document
3+
================================================================
34
45
By default, in HTML output, `plot` will include a .png file with a link to a
56
high-res .png and .pdf. In LaTeX output, it will include a .pdf.

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.