docs: moved latest-version to conf.py

scylladb · Jan 25, 2021 · 7272e02 · 7272e02
1 parent 5472482
commit 7272e02
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 22 deletions.
diff --git a/.github/workflows/pages.yaml b/.github/workflows/pages.yaml
@@ -11,8 +11,6 @@ jobs:
   release:
     name: Release docs
     runs-on: ubuntu-latest
-    env:
-      LATEST_VERSION: v1.0
     steps:
       - name: Checkout
         uses: actions/checkout@v2

diff --git a/docs/_utils/deploy.sh b/docs/_utils/deploy.sh
@@ -8,7 +8,6 @@ set -eu -o pipefail
 # Copy contents
 mkdir gh-pages
 cp -r ./docs/_build/dirhtml/. gh-pages
-./docs/_utils/redirect.sh > gh-pages/index.html
 
 # Create gh-pages branch
 cd gh-pages

diff --git a/docs/_utils/redirect.sh b/docs/_utils/redirect.sh
diff --git a/docs/pyproject.toml b/docs/pyproject.toml
@@ -13,7 +13,7 @@ sphinx-scylladb-theme = "~0.1.11"
 sphinx-sitemap = "2.1.0"
 sphinx-autobuild = "0.7.1"
 Sphinx = "2.4.4"
-sphinx-multiversion-scylla = "0.2.4"
+sphinx-multiversion-scylla = "~0.2.6"
 
 [tool.poetry.dev-dependencies]
 pytest = "5.2"

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -157,6 +157,10 @@ def setup(sphinx):
 # Whitelist pattern for branches (set to None to ignore all branches)
 BRANCHES = ['master', 'v0.3', 'v1.0']
 smv_branch_whitelist = multiversion_regex_builder(BRANCHES)
+# Defines which version is considered to be the latest stable version.
+# Must be listed in smv_tag_whitelist or smv_branch_whitelist.
+smv_latest_version = 'v1.0'
+smv_rename_latest_version = 'stable'
 # Whitelist pattern for remotes (set to None to use local branches only)
 smv_remote_whitelist = r"^origin$"
 # Pattern for released versions