We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 04c9d99 commit 5b1169fCopy full SHA for 5b1169f
doc/format.rst
@@ -443,6 +443,13 @@ The sections of a function's docstring are:
443
``import matplotlib.pyplot as plt``. All other imports, including the
444
demonstrated function, must be explicit.
445
446
+ When matplotlib is imported in the example, the Example code will be
447
+ wrapped in `matplotlib's Sphinx `plot` directive
448
+ <http://matplotlib.org/sampledoc/extensions.html>`_. When matplotlib is
449
+ not explicitly imported, `.. plot::` can be used directly if
450
+ `matplotlib.sphinxext.plot_directive` is loaded as a Sphinx extension in
451
+ ``conf.py``.
452
+
453
454
Documenting classes
455
-------------------
0 commit comments