DOC: Add tags infrastructure for gallery examples

Adds sphinx-tags as a dependency and some basic configuration to display tags with color, using sphinx-design.

Co-authored-by: hannah <[email protected]>
Co-authored-by: esibinga <[email protected]>

Author: 3 people

.gitignore

@@ -82,6 +82,7 @@ galleries/examples/*/*.svgz
 result_images
 doc/_static/constrained_layout*.png
 doc/.mpl_skip_subdirs.yaml
+doc/_tags
 
 # Nose/Pytest generated files #
 ###############################

doc/_static/mpl.css

@@ -3,6 +3,11 @@
     --pst-color-link-hover: var(--pst-color-secondary);
     --sd-color-primary: var(--pst-color-primary);
     --sd-color-primary-text: var(--pst-color-text-base);
+    --sd-color-secondary: #ee9040;
+    --sd-color-success: #28a745;
+    --sd-color-dark: #323232;
+    --sd-color-danger: #dc3545;
+    --sd-color-light: #c9c9c9;
 }
 
 .simple li>p {

doc/conf.py

@@ -118,6 +118,7 @@ def _parse_skip_subdirs_file():
     'sphinxext.redirect_from',
     'sphinx_copybutton',
     'sphinx_design',
+    'sphinx_tags',
 ]
 
 exclude_patterns = [
@@ -282,6 +283,18 @@ def gallery_image_warning_filter(record):
     logger = logging.getLogger('sphinx')
     logger.addFilter(gallery_image_warning_filter)
 
+# Sphinx tags configuration
+tags_create_tags = True
+tags_page_title = "All tags"
+tags_create_badges = True
+tags_badge_colors = {
+    "animation": "primary",
+    "component:*": "secondary",
+    "event-handling": "success",
+    "interactivity:*": "dark",
+    "plot-type:*": "danger",
+    "*": "light"  # default value
+}
 
 mathmpl_fontsize = 11.0
 mathmpl_srcset = ['2x']

environment.yml

@@ -39,6 +39,7 @@ dependencies:
   - sphinx-copybutton
   - sphinx-gallery>=0.12
   - sphinx-design
+  - sphinx-tags
   - pip
   - pip:
       - mpl-sphinx-theme

galleries/examples/README.txt

@@ -14,3 +14,7 @@ and source code.
 For longer tutorials, see our :ref:`tutorials page <tutorials>`.
 You can also find :ref:`external resources <resources-index>` and
 a :ref:`FAQ <faq-index>` in our :ref:`user guide <users-guide-index>`.
+
+
+.. note::
+    You can also browse the example gallery by :ref:`tags <tagoverview>`.

galleries/examples/animation/animated_histogram.py

@@ -55,3 +55,6 @@ def animate(frame_number):
 ani = animation.FuncAnimation(fig, prepare_animation(bar_container), 50,
                               repeat=False, blit=True)
 plt.show()
+
+# %%
+# .. tags:: plot-type:histogram, animation

galleries/examples/animation/multiple_axes.py

@@ -80,3 +80,5 @@ def animate(i):
 #
 #    - `matplotlib.patches.ConnectionPatch`
 #    - `matplotlib.animation.FuncAnimation`
+#
+# .. tags:: component:axes, animation

galleries/examples/event_handling/resample.py

@@ -75,3 +75,6 @@ def update(self, ax):
 ax.callbacks.connect('xlim_changed', d.update)
 ax.set_xlim(16, 365)
 plt.show()
+
+# %%
+# .. tags:: interactivity:zoom, event-handling

requirements/doc/doc-requirements.txt

@@ -21,3 +21,4 @@ sphinxcontrib-svg2pdfconverter>=1.1.0
 sphinx-gallery>=0.12.0
 sphinx-copybutton
 sphinx-design
+sphinx-tags