@@ -24,11 +24,12 @@ ReadTheDocs, you may wish to build imagery locally to avoid hitting resource
2424limits on the server. Using the new changes allows extensive dynamically
2525generated imagery to be used on services like ReadTheDocs.
2626
27- The `:outname: ` property
28- ~~~~~~~~~~~~~~~~~~~~~~~~
27+ The `` :outname: ` ` property
28+ ~~~~~~~~~~~~~~~~~~~~~~~~~~
2929
30- These problems are addressed through two new features in the plot directive. The
31- first is the introduction of the `:outname: ` property. It is used like so:
30+ These problems are addressed through two new features in the plot directive.
31+ The first is the introduction of the ``:outname: `` property. It is used like
32+ so:
3233
3334.. code-block :: rst
3435
@@ -41,20 +42,20 @@ first is the introduction of the `:outname:` property. It is used like so:
4142 img = mpimg.imread('_static/stinkbug.png')
4243 imgplot = plt.imshow(img)
4344
44- :outname: `, the figure generated above would normally be called, e.g.
45- `docfile3-4-01.png ` or something equally mysterious. With `:outname: ` the figure
46- generated will instead be named `stinkbug_plot-01.png ` or even
47- `stinkbug_plot.png `. This makes it easy to understand which output image is
48- which and, more importantly, uniquely keys output images to code snippets.
45+ :outname: ``, the figure generated above would normally be called,
46+ e.g. :file: `docfile3-4-01.png ` or something equally mysterious. With
47+ ``:outname: `` the figure generated will instead be named
48+ :file: `stinkbug_plot-01.png ` or even :file: `stinkbug_plot.png `. This makes it
49+ easy to understand which output image is which and, more importantly, uniquely
50+ keys output images to code snippets.
4951
50- The `plot_preserve_dir ` configuration value
51- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
52+ The `` plot_preserve_dir ` ` configuration value
53+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5254
53- Setting the `plot_preserve_dir ` configuration value to the name of a directory
54- will cause all images with `:outname: ` set to be copied to this directory upon
55- generation.
55+ Setting the `` plot_preserve_dir `` configuration value to the name of a
56+ directory will cause all images with `` :outname: `` set to be copied to this
57+ directory upon generation.
5658
57- If an image is already in `plot_preserve_dir ` when documentation is being
59+ If an image is already in `` plot_preserve_dir ` ` when documentation is being
5860generated, this image is copied to the build directory thereby pre-empting
5961generation and reducing computation time in low-resource environments.
60-
0 commit comments