Parameterize version numbers in docs

Author: NickCao

docs/source/conf.py

@@ -18,7 +18,14 @@
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ["sphinxcontrib.mermaid", "myst_parser", "sphinx.ext.autodoc", "sphinx.ext.doctest", "sphinx_click"]
+extensions = [
+    "sphinxcontrib.mermaid",
+    "myst_parser",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.doctest",
+    "sphinx_click",
+    "sphinx_substitution_extensions",
+]
 
 templates_path = ["_templates"]
 exclude_patterns = []
@@ -32,4 +39,11 @@
 # html_static_path = ["_static"]
 html_extra_path = ["extra"]
 html_title = "Jumpstarter Docs"
+
 myst_heading_anchors = 3
+myst_enable_extensions = [
+    "substitution",
+]
+myst_substitutions = {
+    "version": "0.5.0rc2",
+}

docs/source/installation/service-cli.md

@@ -7,8 +7,9 @@ Please refer to https://github.com/jumpstarter-dev/jumpstarter-controller/releas
 the latest release.
 
 ## Installing the CLI
-```bash
-export VERSION=0.1.0
+```{code-block} bash
+:substitutions:
+export VERSION={{version}}
 export ARCH=amd64
 
 curl -L https://github.com/jumpstarter-dev/jumpstarter-controller/releases/download/${VERSION}/jmpctl_${VERSION}_linux_${ARCH} \

docs/source/installation/service/kind-helm.md

@@ -58,7 +58,8 @@ kind create cluster  --config kind_config.yaml
 
 ### Install Jumpstarter
 
-```bash
+```{code-block} bash
+:substitutions:
 export BASEDOMAIN="jumpstarter.${IP}.nip.io"
 export GRPC_ENDPOINT="grpc.${BASEDOMAIN}:8082"
 export GRPC_ROUTER_ENDPOINT="router.${BASEDOMAIN}:8083"
@@ -71,6 +72,5 @@ helm upgrade jumpstarter --install oci://quay.io/jumpstarter-dev/helm/jumpstarte
             --set global.metrics.enabled=false \
             --set jumpstarter-controller.grpc.nodeport.enabled=true \
             --set jumpstarter-controller.grpc.mode=nodeport \
-            --version=0.1.0
-        {{< / highlight >}}
-```
+            --version={{version}}
+```

docs/source/installation/service/kubernetes-helm.md

@@ -11,11 +11,12 @@ Please note that `global.baseDomain` is used to create the host names for the se
 with the provided example the services will be available at grpc.jumpstarter.example.com
 ```
 
-```bash
-    helm upgrade jumpstarter --install oci://quay.io/jumpstarter-dev/helm/jumpstarter \
-            --create-namespace --namespace jumpstarter-lab \
-            --set global.baseDomain=jumpstarter.example.com \
-            --set global.metrics.enabled=true # disable if metrics not available \
-            --set jumpstarter-controller.grpc.mode=ingress \
-            --version=0.1.0
-```
+```{code-block} bash
+:substitutions:
+helm upgrade jumpstarter --install oci://quay.io/jumpstarter-dev/helm/jumpstarter \
+        --create-namespace --namespace jumpstarter-lab \
+        --set global.baseDomain=jumpstarter.example.com \
+        --set global.metrics.enabled=true # disable if metrics not available \
+        --set jumpstarter-controller.grpc.mode=ingress \
+        --version={{version}}
+```

docs/source/installation/service/minikube-helm.md

@@ -29,7 +29,8 @@ export IP=$(minikube ip)
 ```
 
 ### Install Jumpstarter
-```bash
+```{code-block} bash
+:substitutions:
 export BASEDOMAIN="jumpstarter.${IP}.nip.io"
 export GRPC_ENDPOINT="grpc.${BASEDOMAIN}:8082"
 export GRPC_ROUTER_ENDPOINT="router.${BASEDOMAIN}:8083"
@@ -42,5 +43,5 @@ helm upgrade jumpstarter --install oci://quay.io/jumpstarter-dev/helm/jumpstarte
             --set global.metrics.enabled=false \
             --set jumpstarter-controller.grpc.nodeport.enabled=true \
             --set jumpstarter-controller.grpc.mode=nodeport \
-            --version=0.1.0
-```
+            --version={{version}}
+```

docs/source/installation/service/openshift-argocd.md

@@ -63,7 +63,8 @@ auto-generate values for these, but with ArgoCD such mechanism doesn't work. You
 create these secrets in the namespace where the jumpstarter is installed.
 ```
 
-```yaml
+```{code-block} yaml
+:substitutions:
 apiVersion: argoproj.io/v1alpha1
 kind: Application
 metadata:
@@ -89,6 +90,6 @@ spec:
       - name: jumpstarter-controller.grpc.mode
         value: "route"
     repoURL: quay.io/jumpstarter-dev/helm
-    targetRevision: "0.1.0"
+    targetRevision: "{{version}}"
 ```
 

docs/source/installation/service/openshift-helm.md

@@ -12,13 +12,14 @@ this is because the install process will install some CRDs and ClusterRoles.
 
 To install using helm:
 
-```bash
-  helm upgrade jumpstarter --install oci://quay.io/jumpstarter-dev/helm/jumpstarter \
-              --create-namespace --namespace jumpstarter-lab \
-              --set global.baseDomain=jumpstarter.example.com \
-              --set global.metrics.enabled=true \
-              --set jumpstarter-controller.grpc.mode=route \
-              --version=0.1.0
+```{code-block} bash
+:substitutions:
+helm upgrade jumpstarter --install oci://quay.io/jumpstarter-dev/helm/jumpstarter \
+          --create-namespace --namespace jumpstarter-lab \
+          --set global.baseDomain=jumpstarter.example.com \
+          --set global.metrics.enabled=true \
+          --set jumpstarter-controller.grpc.mode=route \
+          --version={{version}}
 ```
 
 

pyproject.toml

@@ -36,6 +36,7 @@ docs = [
     "esbonio>=0.16.4",
     "sphinx-autobuild>=2024.4.16",
     "sphinx-click>=6.0.0",
+    "sphinx-substitution-extensions>=2024.10.17",
 ]
 dev = [
     "pytest>=8.3.2",