Merge pull request #1665 from minrk/template-vars

enable myst substitutions

Author: minrk

.github/workflows/test.yml

@@ -5,7 +5,11 @@ on:
     branches-ignore:
       - "dependabot/**"
       - "pre-commit-ci-update-config"
+    paths-ignore:
+      - "docs/**"
   pull_request:
+    paths-ignore:
+      - "docs/**"
 
 env:
   FORCE_COLOR: "1"

docs/source/conf.py

@@ -22,10 +22,6 @@
 
 target_libzmq = '%i.%i.%i' % bundled_version
 
-rst_epilog = f"""
-.. |target_libzmq| replace:: {target_libzmq}
-"""
-
 # -- General configuration -----------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
@@ -43,7 +39,9 @@
     "colon_fence",
     "linkify",
     "smartquotes",
+    "substitution",
 ]
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
@@ -73,10 +71,16 @@
 import zmq
 
 # The short X.Y version.
-version = zmq.__version__.split('-')[0]
+version = '.'.join(zmq.__version__.split('.')[:2])
 # The full version, including alpha/beta/rc tags.
 release = zmq.__version__
 
+myst_substitutions = {
+    "version": version,
+    "release": release,
+    "target_libzmq": target_libzmq,
+}
+
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 # language = None