Skip to content

Commit 4cb2ac3

Browse files
dgarcia360fruch
authored andcommitted
docs: update theme 1.3
1 parent 3c55ec8 commit 4cb2ac3

File tree

5 files changed

+12
-7
lines changed

5 files changed

+12
-7
lines changed

.github/workflows/docs-pages.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ jobs:
2929
run: python setup.py develop
3030
- name: Build docs
3131
run: make -C docs multiversion
32+
- name: Build redirects
33+
run: make -C docs redirects
3234
- name: Deploy docs to GitHub Pages
3335
run: ./docs/_utils/deploy.sh
3436
env:

docs/Makefile

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Global variables
22
# You can set these variables from the command line.
33
POETRY = poetry
4-
SPHINXOPTS =
4+
SPHINXOPTS =
55
SPHINXBUILD = $(POETRY) run sphinx-build
66
PAPER =
77
BUILDDIR = _build
@@ -72,6 +72,12 @@ multiversion: setup
7272
@echo
7373
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
7474

75+
.PHONY: redirects
76+
redirects: setup
77+
$(POETRY) run redirects-cli fromfile --yaml-file _utils/redirects.yaml --output-dir $(BUILDDIR)/dirhtml
78+
@echo
79+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
80+
7581
# Preview commands
7682
.PHONY: preview
7783
preview: setup
@@ -91,3 +97,4 @@ test: setup
9197
.PHONY: linkcheck
9298
linkcheck: setup
9399
$(SPHINXBUILD) -b linkcheck $(SOURCEDIR) $(BUILDDIR)/linkcheck
100+

docs/_utils/redirects.yaml

Whitespace-only changes.

docs/conf.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -77,11 +77,6 @@
7777
# Prefix added to all the URLs generated in the 404 page.
7878
notfound_urls_prefix = ''
7979

80-
# -- Options for redirect extension --------------------------------------------
81-
82-
# Read a YAML dictionary of redirections and generate an HTML file for each
83-
redirects_file = '_utils/redirections.yaml'
84-
8580
# -- Options for multiversion --------------------------------------------------
8681

8782
# Whitelist pattern for tags

docs/pyproject.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,10 @@ python = "^3.7"
1414
pyyaml = "6.0"
1515
pygments = "2.2.0"
1616
recommonmark = "0.7.1"
17+
redirects_cli ="^0.1.2"
1718
sphinx-autobuild = "2021.3.14"
1819
sphinx-sitemap = "2.1.0"
19-
sphinx-scylladb-theme = "~1.2.1"
20+
sphinx-scylladb-theme = "~1.3.1"
2021
sphinx-multiversion-scylla = "~0.2.11"
2122
Sphinx = "4.3.2"
2223
scales = "1.0.9"

0 commit comments

Comments
 (0)