Skip to content

Commit 81d289b

Browse files
committed
adds versionadded, whats_new file
1 parent 0a1931b commit 81d289b

2 files changed

Lines changed: 13 additions & 0 deletions

File tree

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
New config option for ``matplotlib.sphinxext.plot_directive``: ``plot_skip_all``
2+
--------------------------------------------------------------------------------
3+
4+
This configuration option allows users to temporarily skip all plot directives,
5+
not running the code or generating the plots. It is intended to be used during
6+
development to speed up building documentation that contains many plot
7+
directives.
8+
9+
It can be temporarily enabled from the command line by passing ``-D
10+
plot_skip_all=1`` to ``sphinx-build``, e.g.,: ``make html O="-D
11+
plot_skip_all=1"``.

‎lib/matplotlib/sphinxext/plot_directive.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,8 @@
166166
If True, will not run any plot directives. Code, captions, etc. will all
167167
still be rendered, but no plots will be created.
168168
169+
.. versionadded:: 3.11
170+
169171
Notes on how it works
170172
---------------------
171173

0 commit comments

Comments
 (0)