Merge pull request #22405 from jklymak/doc-fix-gallery-keywords

story645 · web-flow · commit fbcfea46e725 · 2022-05-19T17:11:41.000-04:00
DOC: put the gallery keywords in the meta tag
diff --git a/doc/conf.py b/doc/conf.py
@@ -198,15 +198,30 @@ def matplotlib_reduced_latex_scraper(block, block_vars, gallery_conf,
 mathmpl_fontsize = 11.0
 mathmpl_srcset = ['2x']
 
-# Monkey-patching gallery signature to include search keywords
-gen_rst.SPHX_GLR_SIG = """\n
+# Monkey-patching gallery header to include search keywords
+gen_rst.EXAMPLE_HEADER = """
+.. DO NOT EDIT.
+.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
+.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
+.. "{0}"
+.. LINE NUMBERS ARE GIVEN BELOW.
+
 .. only:: html
 
- .. rst-class:: sphx-glr-signature
+    .. meta::
+        :keywords: codex
+
+    .. note::
+        :class: sphx-glr-download-link-note
+
+        Click :ref:`here <sphx_glr_download_{1}>`
+        to download the full example code{2}
 
-    Keywords: matplotlib code example, codex, python plot, pyplot
-    `Gallery generated by Sphinx-Gallery
-    <https://sphinx-gallery.readthedocs.io>`_\n"""
+.. rst-class:: sphx-glr-example-title
+
+.. _sphx_glr_{1}:
+
+"""
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
