Fix doc style

timhoffm · timhoffm · commit 2c10b86ade0e · 2019-11-24T19:10:26.000+01:00
diff --git a/doc/users/next_whats_new/2018_12_03_sphinx_plot_preserve.rst b/doc/users/next_whats_new/2018_12_03_sphinx_plot_preserve.rst
@@ -24,11 +24,12 @@ ReadTheDocs, you may wish to build imagery locally to avoid hitting resource
 limits on the server. Using the new changes allows extensive dynamically
 generated imagery to be used on services like ReadTheDocs.
 
-The `:outname:` property
-~~~~~~~~~~~~~~~~~~~~~~~~
+The ``:outname:`` property
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-These problems are addressed through two new features in the plot directive. The
-first is the introduction of the `:outname:` property. It is used like so:
+These problems are addressed through two new features in the plot directive.
+The first is the introduction of the ``:outname:`` property. It is used like
+so:
 
 .. code-block:: rst
 
@@ -41,20 +42,20 @@ first is the introduction of the `:outname:` property. It is used like so:
        img = mpimg.imread('_static/stinkbug.png')
        imgplot = plt.imshow(img)
 
-Without `:outname:`, the figure generated above would normally be called, e.g.
-`docfile3-4-01.png` or something equally mysterious. With `:outname:` the figure
-generated will instead be named `stinkbug_plot-01.png` or even
-`stinkbug_plot.png`. This makes it easy to understand which output image is
-which and, more importantly, uniquely keys output images to code snippets.
+Without ``:outname:``, the figure generated above would normally be called,
+e.g. :file:`docfile3-4-01.png` or something equally mysterious. With
+``:outname:`` the figure generated will instead be named
+:file:`stinkbug_plot-01.png` or even :file:`stinkbug_plot.png`. This makes it
+easy to understand which output image is which and, more importantly, uniquely
+keys output images to code snippets.
 
-The `plot_preserve_dir` configuration value
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The ``plot_preserve_dir`` configuration value
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Setting the `plot_preserve_dir` configuration value to the name of a directory
-will cause all images with `:outname:` set to be copied to this directory upon
-generation.
+Setting the ``plot_preserve_dir`` configuration value to the name of a
+directory will cause all images with ``:outname:`` set to be copied to this
+directory upon generation.
 
-If an image is already in `plot_preserve_dir` when documentation is being
+If an image is already in ``plot_preserve_dir`` when documentation is being
 generated, this image is copied to the build directory thereby pre-empting
 generation and reducing computation time in low-resource environments.
-
diff --git a/lib/matplotlib/sphinxext/plot_directive.py b/lib/matplotlib/sphinxext/plot_directive.py
@@ -672,11 +672,11 @@ def run(arguments, content, options, state_machine, state, lineno):
     rst_file = document.attributes['source']
     rst_dir = os.path.dirname(rst_file)
 
-    #Get output name of the images, if the option was provided
+    # Get output name of the images, if the option was provided
     outname = options.get('outname', '')
 
-    #Ensure that the outname is unique, otherwise copied images will
-    #not be what user expects
+    # Ensure that the outname is unique, otherwise copied images will
+    # not be what user expects
     if outname and outname in _outname_list:
         raise Exception("The outname '{0}' is not unique!".format(outname))
     else:
@@ -722,8 +722,8 @@ def run(arguments, content, options, state_machine, state, lineno):
     else:
         source_ext = ''
 
-    #outname, if present, overrides output_base, but preserve
-    #numbering of multi-figure code snippets
+    # outname, if present, overrides output_base, but preserve
+    # numbering of multi-figure code snippets
     if outname:
         output_base = re.sub('^[^-]*', outname, output_base)
 
@@ -773,9 +773,8 @@ def run(arguments, content, options, state_machine, state, lineno):
         build_dir_link = build_dir
     source_link = dest_dir_link + '/' + output_base + source_ext
 
-    #If we previously preserved copies of the generated figures
-    #this copies them into the build directory so that they will
-    #not be remade
+    # If we previously preserved copies of the generated figures this copies
+    # them into the build directory so that they will not be remade.
     if config.plot_preserve_dir and outname:
         outfiles = glob.glob(
             os.path.join(config.plot_preserve_dir, outname) + '*')
