diff --git a/.github/workflows/jenkins_branch.yml b/.github/workflows/release.yml similarity index 97% rename from .github/workflows/jenkins_branch.yml rename to .github/workflows/release.yml index c997192b..2bbb3e1c 100644 --- a/.github/workflows/jenkins_branch.yml +++ b/.github/workflows/release.yml @@ -1,4 +1,4 @@ -name: Handle jenkins branch for release validation +name: Workflow for release branches on: push: branches: diff --git a/docs/_templates/versions.html b/docs/_templates/versions.html new file mode 100644 index 00000000..31a12578 --- /dev/null +++ b/docs/_templates/versions.html @@ -0,0 +1,27 @@ +{%- if current_version %} +
+ + Other Versions + v: {{ current_version.name }} + + +
+ {%- if versions.tags %} +
+
Tags
+ {%- for item in versions.tags %} +
{{ item.name }}
+ {%- endfor %} +
+ {%- endif %} + {%- if versions.branches %} +
+
Branches
+ {%- for item in versions.branches %} +
{{ item.name }}
+ {%- endfor %} +
+ {%- endif %} +
+
+{%- endif %} diff --git a/docs/assets/index.html b/docs/assets/index.html new file mode 100644 index 00000000..862d8d64 --- /dev/null +++ b/docs/assets/index.html @@ -0,0 +1,9 @@ + + + + Redirecting to last stable tag + + + + + diff --git a/docs/conf.py b/docs/conf.py index 92ce300d..ccf5e97e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -31,6 +31,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + 'sphinx_multiversion', 'sphinx_tabs.tabs', 'sphinx.ext.autosectionlabel' ] @@ -344,3 +345,7 @@ # -- Options for sphinx-versioning ------------------------------------------- scv_whitelist_branches = ('(stable|release){1}/.+',) +# -- Options for sphinx-multiversion------------------------------------------ +smv_tag_whitelist = r'^\d+\.\d+\.\d+$' +smv_branch_whitelist = r'(stable|release){1}/.+' +smv_remote_whitelist = r'^.*$' diff --git a/docs/requirements.txt b/docs/requirements.txt index fc5c9138..67a76961 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,5 @@ sphinx sphinx-rtd-theme sphinx-tabs +sphinx-multiversion +ghp-import