Merge pull request #11295 from timhoffm/only-directive

jklymak · web-flow · commit f87c686a8d1b · 2018-05-25T16:07:27.000-07:00
Use sphinx builtin only directive instead of custom one.
diff --git a/doc/api/index.rst b/doc/api/index.rst
@@ -4,7 +4,7 @@
   The Matplotlib API
 ####################
 
-.. htmlonly::
+.. only:: html
 
    :Release: |version|
    :Date: |today|
diff --git a/doc/conf.py b/doc/conf.py
@@ -38,7 +38,6 @@
     'numpydoc',  # Needs to be loaded *after* autodoc.
     'sphinx_gallery.gen_gallery',
     'matplotlib.sphinxext.mathmpl',
-    'matplotlib.sphinxext.only_directives',
     'matplotlib.sphinxext.plot_directive',
     'sphinxext.custom_roles',
     'sphinxext.github',
diff --git a/doc/contents.rst b/doc/contents.rst
@@ -3,7 +3,7 @@
 Overview
 ========
 
-.. htmlonly::
+.. only:: html
 
     :Release: |version|
     :Date: |today|
@@ -23,7 +23,7 @@ Overview
    devel/index.rst
    glossary/index.rst
 
-.. htmlonly::
+.. only:: html
 
   * :ref:`genindex`
   * :ref:`modindex`
diff --git a/doc/devel/MEP/index.rst b/doc/devel/MEP/index.rst
@@ -2,7 +2,7 @@
 
 .. include:: README.rst
 
-.. htmlonly::
+.. only:: html
 
    :Release: |version|
    :Date: |today|
diff --git a/doc/devel/index.rst b/doc/devel/index.rst
@@ -4,7 +4,7 @@
 The Matplotlib Developers' Guide
 ################################
 
-.. htmlonly::
+.. only:: html
 
    :Release: |version|
    :Date: |today|
diff --git a/doc/faq/howto_faq.rst b/doc/faq/howto_faq.rst
@@ -350,7 +350,7 @@ and patches, respectively::
 
     line, = ax.plot(x, y, zorder=10)
 
-.. htmlonly::
+.. only:: html
 
     See :ref:`sphx_glr_gallery_misc_zorder_demo.py` for a complete example.
 
@@ -369,7 +369,7 @@ some ratio which controls the ratio::
 
   ax = fig.add_subplot(111, aspect='equal')
 
-.. htmlonly::
+.. only:: html
 
     See :ref:`sphx_glr_gallery_subplots_axes_and_figures_axis_equal_demo.py` for a
     complete example.
@@ -413,7 +413,7 @@ locators as desired because the two axes are independent.
     plt.show()
 
 
-.. htmlonly::
+.. only:: html
 
     See :ref:`sphx_glr_gallery_api_two_scales.py` for a complete example
 
diff --git a/doc/faq/index.rst b/doc/faq/index.rst
@@ -4,7 +4,7 @@
 The Matplotlib FAQ
 ##################
 
-.. htmlonly::
+.. only:: html
 
    :Release: |version|
    :Date: |today|
diff --git a/doc/users/index.rst b/doc/users/index.rst
@@ -4,7 +4,7 @@
 User's Guide
 ############
 
-.. htmlonly::
+.. only:: html
 
     :Release: |version|
     :Date: |today|
diff --git a/lib/matplotlib/image.py b/lib/matplotlib/image.py
@@ -1474,7 +1474,7 @@ def thumbnail(infile, thumbfile, scale=0.1, interpolation='bilinear',
 
     See examples/misc/image_thumbnail.py.
 
-    .. htmlonly::
+    .. only:: html
 
         :ref:`sphx_glr_gallery_misc_image_thumbnail_sgskip.py`
 
diff --git a/lib/matplotlib/sphinxext/only_directives.py b/lib/matplotlib/sphinxext/only_directives.py
diff --git a/lib/matplotlib/sphinxext/plot_directive.py b/lib/matplotlib/sphinxext/plot_directive.py
@@ -412,7 +412,7 @@ def remove_coding(text):
 """
 
 exception_template = """
-.. htmlonly::
+.. only:: html
 
    [`source code <%(linkdir)s/%(basename)s.py>`__]
 
diff --git a/tutorials/text/mathtext.py b/tutorials/text/mathtext.py
@@ -221,7 +221,7 @@
 #     ``\mathrm{\mathsf{sansserif}}``        :math-stix:`\mathrm{\mathsf{sansserif}}`
 #     ====================================== =========================================
 #
-#   .. htmlonly::
+#   .. only:: html
 #
 #     ====================================== =========================================
 #     ``\mathcircled{circled}``              :math-stix:`\mathcircled{circled}`
diff --git a/tutorials/text/pgf.py b/tutorials/text/pgf.py
@@ -110,12 +110,12 @@
 if you want to do the font configuration yourself instead of using the fonts
 specified in the rc parameters, make sure to disable ``pgf.rcfonts``.
 
-.. htmlonly::
+.. only:: html
 
     .. literalinclude:: ../../gallery/userdemo/pgf_preamble_sgskip.py
         :end-before: plt.savefig
 
-.. latexonly::
+.. only:: latex
 
     .. literalinclude:: ../../gallery/userdemo/pgf_preamble_sgskip.py
         :end-before: import matplotlib.pyplot as plt
