🩹Fix JSON-links on RTD (#728)

Author: lord-haffi

.readthedocs.yaml

@@ -14,6 +14,12 @@ build:
     # nodejs: "16"
     # rust: "1.55"
     # golang: "1.17"
+  jobs:
+    pre_build:
+      - python -m pip install -e .
+      - python -c "import bo4e; print(bo4e.__gh_version__)"
+      # This ensures that before trying to build the documentation, the package will have information about the
+      # version tag. This is necessary for the documentation to build the links correctly.
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:

docs/conf.py

@@ -177,12 +177,16 @@
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
 try:
-    from bo4e import __version__ as version
+    from bo4e import __gh_version__ as version
+
+    print(f"Got version {version} from __gh_version__")
 except ImportError:
     pass
 else:
     release = version
 
+print(f"Using version {release} for documentation")
+
 # A shorter title for the navigation bar.  Default is the same as html_title.
 # html_short_title = None
 

src/bo4e/version.py

@@ -12,6 +12,12 @@
 # Please keep this name in sync with the name of the project in pyproject.toml
 # This name is the name of the package on pypi.org
 if re.match(r"^(\d+\.\d+\.\d+)(rc\d+)?$", __version__):
-    __gh_version__ = re.sub(r"^(\d+\.\d+\.\d+)(rc\d+)?$", r"v\1-\2", __version__)
+
+    def _repl(match: re.Match[str]) -> str:
+        if match.group(2) is not None:
+            return f"v{match.group(1)}-{match.group(2)}"
+        return f"v{match.group(1)}"
+
+    __gh_version__ = re.sub(r"^(\d+\.\d+\.\d+)(rc\d+)?$", _repl, __version__)
 else:
     __gh_version__ = f"v{__version__}"