Merge pull request #14542 from anntzer/sphinxextapi

tacaswell · web-flow · commit b148183cc060 · 2019-06-14T12:29:18.000-04:00
DOC: Move plot_directive doc to main API index.
diff --git a/doc/api/index.rst b/doc/api/index.rst
@@ -115,6 +115,7 @@ Matplotlib consists of the following submodules:
    rcsetup_api.rst
    sankey_api.rst
    scale_api.rst
+   sphinxext_plot_directive_api.rst
    spines_api.rst
    style_api.rst
    table_api.rst
diff --git a/doc/api/sphinxext_plot_directive_api.rst b/doc/api/sphinxext_plot_directive_api.rst
@@ -0,0 +1,6 @@
+=======================================
+``matplotlib.sphinxext.plot_directive``
+=======================================
+
+.. automodule:: matplotlib.sphinxext.plot_directive
+   :no-undoc-members:
diff --git a/doc/devel/documenting_mpl.rst b/doc/devel/documenting_mpl.rst
@@ -678,7 +678,7 @@ Note that ``examples/text_labels_and_annotations/legend.py`` has been mapped to
 fixed in future re-organization of the docs.
 
 Plots can also be directly placed inside docstrings.  Details are in
-:doc:`/devel/plot_directive`.  A short example is:
+:doc:`/api/sphinxext_plot_directive_api`.  A short example is:
 
 .. code-block:: python
 
diff --git a/doc/devel/index.rst b/doc/devel/index.rst
@@ -15,7 +15,6 @@ The Matplotlib Developers' Guide
    contributing.rst
    testing.rst
    documenting_mpl.rst
-   plot_directive.rst
    add_new_projection.rst
    gitwash/index.rst
    coding_guide.rst
diff --git a/doc/devel/plot_directive.rst b/doc/devel/plot_directive.rst
diff --git a/lib/matplotlib/sphinxext/plot_directive.py b/lib/matplotlib/sphinxext/plot_directive.py
@@ -1,5 +1,6 @@
 """
-A directive for including a matplotlib plot in a Sphinx document.
+A directive for including a Matplotlib plot in a Sphinx document
+================================================================
 
 By default, in HTML output, `plot` will include a .png file with a link to a
 high-res .png and .pdf.  In LaTeX output, it will include a .pdf.
