Skip to content

Commit

Permalink
Revert "docs: moved latest-version to conf.py"
Browse files Browse the repository at this point in the history
This reverts commit 7272e02.
  • Loading branch information
zimnx committed Jan 28, 2021
1 parent ec4edf1 commit 8855023
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 5 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/pages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ jobs:
release:
name: Release docs
runs-on: ubuntu-latest
env:
LATEST_VERSION: v1.0
steps:
- name: Checkout
uses: actions/checkout@v2
Expand Down
1 change: 1 addition & 0 deletions docs/_utils/deploy.sh
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ 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
Expand Down
18 changes: 18 additions & 0 deletions docs/_utils/redirect.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
#!/usr/bin/env bash
#
# Copyright (C) 2017 ScyllaDB
#

set -eu -o pipefail

cat <<- _EOF_
<!DOCTYPE html>
<html>
<head>
<title>Redirecting to Driver</title>
<meta charset="utf-8">
<meta http-equiv="refresh" content="0; URL=./${LATEST_VERSION}/index.html">
<link rel="canonical" href="./${LATEST_VERSION}/index.html">
</head>
</html>
_EOF_
2 changes: 1 addition & 1 deletion docs/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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.6"
sphinx-multiversion-scylla = "0.2.4"

[tool.poetry.dev-dependencies]
pytest = "5.2"
Expand Down
4 changes: 0 additions & 4 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -157,10 +157,6 @@ 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
Expand Down

0 comments on commit 8855023

Please sign in to comment.