Skip to content

Commit

Permalink
docs: fix myst_substitutions for kube_version containing >
Browse files Browse the repository at this point in the history
  • Loading branch information
consideRatio committed Jan 4, 2021
1 parent 9c5ff37 commit 2687cb0
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
5 changes: 4 additions & 1 deletion doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,10 @@ def _get_git_ref_from_chartpress_based_version(version):
chart_version = chart["version"]
chart_version_git_ref = _get_git_ref_from_chartpress_based_version(chart_version)
jupyterhub_version = chart["appVersion"]
kube_version = chart["kubeVersion"].split("-", 1)[0]
# FIXME: kubeVersion contain >=, but by having > in the string we substitute we
# run into this issue:
# https://github.com/executablebooks/MyST-Parser/issues/282
kube_version = chart["kubeVersion"].split("-", 1)[0][2:]

# These substitution variables only work in markdown contexts, and does not work
# within links etc. Reference using {{ variable_name }}
Expand Down
2 changes: 1 addition & 1 deletion doc/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ you have tips or deployments that you would like to share, see the

This documentation is for Helm chart version {{chart_version}} that deploys
JupyterHub version {{jupyterhub_version}} and other other components versioned
in {{requirements}}. The Helm chart requires Kubernetes version {{kube_version}}
in {{requirements}}. The Helm chart requires Kubernetes version >={{kube_version}}
and Helm >=2.16.

```{admonition} Note
Expand Down

0 comments on commit 2687cb0

Please sign in to comment.