Skip to content

Commit d2e261b

Browse files
dgarcia360avelanarius
authored andcommitted
docs: update theme 1.3
1 parent 627b1ad commit d2e261b

File tree

7 files changed

+14
-11
lines changed

7 files changed

+14
-11
lines changed

.github/workflows/docs-pages.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ jobs:
3333
java-version: 1.8
3434
- name: Set up env
3535
run: make -C docs setupenv
36+
- name: Build redirects
37+
run: make -C docs redirects
3638
- name: Build docs
3739
run: make -C docs multiversion
3840
- name: Deploy docs to GitHub Pages

docs/Makefile

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,12 @@ preview: setup
9595
multiversionpreview: multiversion
9696
$(POETRY) run python -m http.server 5500 --directory $(BUILDDIR)/dirhtml
9797

98+
.PHONY: redirects
99+
redirects: setup
100+
$(POETRY) run redirects-cli fromfile --yaml-file _utils/redirects.yaml --output-dir $(BUILDDIR)/dirhtml
101+
@echo
102+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
103+
98104
# Test commands
99105
.PHONY: test
100106
test: setup

docs/_utils/multiversion.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#! /bin/bash
22

33
cd .. && sphinx-multiversion docs/source docs/_build/dirhtml \
4-
--pre-build './docs/_utils/javadoc.sh' \
5-
--pre-build "find . -mindepth 2 -name README.md -execdir mv '{}' index.md ';'"
4+
--pre-build "find . -mindepth 2 -name README.md -execdir mv '{}' index.md ';'" \
5+
--post-build './docs/_utils/javadoc.sh'

docs/_utils/redirections.yaml

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/_utils/redirects.yaml

Whitespace-only changes.

docs/pyproject.toml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,12 @@ python = "^3.7"
99
pyyaml = "6.0"
1010
pygments = "2.2.0"
1111
recommonmark = "0.7.1"
12-
sphinx-scylladb-theme = "~1.2.1"
12+
redirects_cli ="~0.1.2"
13+
sphinx-scylladb-theme = "~1.3.1"
1314
sphinx-sitemap = "2.1.0"
1415
sphinx-autobuild = "2021.3.14"
1516
Sphinx = "4.3.2"
16-
sphinx-multiversion-scylla = "~0.2.11"
17+
sphinx-multiversion-scylla = "~0.2.12"
1718

1819
[build-system]
1920
requires = ["poetry>=0.12"]

docs/source/conf.py

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
# Set which versions are not released yet.
2020
UNSTABLE_VERSIONS = []
2121
# Set which versions are deprecated
22-
DEPRECATED_VERSIONS = ['']
22+
DEPRECATED_VERSIONS = []
2323

2424
# Add any Sphinx extension module names here, as strings. They can be
2525
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -116,11 +116,6 @@ def setup(app):
116116
# Prefix added to all the URLs generated in the 404 page.
117117
notfound_urls_prefix = ''
118118

119-
# -- Options for redirect extension ---------------------------------------
120-
121-
# Read a YAML dictionary of redirections and generate an HTML file for each
122-
redirects_file = "_utils/redirections.yaml"
123-
124119
# -- Options for multiversion extension ----------------------------------
125120

126121
# Whitelist pattern for tags

0 commit comments

Comments
 (0)