Skip to content

Commit

Permalink
docs: update theme 1.3
Browse files Browse the repository at this point in the history
  • Loading branch information
dgarcia360 authored and avelanarius committed Jan 18, 2023
1 parent 627b1ad commit d2e261b
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 11 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/docs-pages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ jobs:
java-version: 1.8
- name: Set up env
run: make -C docs setupenv
- name: Build redirects
run: make -C docs redirects
- name: Build docs
run: make -C docs multiversion
- name: Deploy docs to GitHub Pages
Expand Down
6 changes: 6 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,12 @@ preview: setup
multiversionpreview: multiversion
$(POETRY) run python -m http.server 5500 --directory $(BUILDDIR)/dirhtml

.PHONY: redirects
redirects: setup
$(POETRY) run redirects-cli fromfile --yaml-file _utils/redirects.yaml --output-dir $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."

# Test commands
.PHONY: test
test: setup
Expand Down
4 changes: 2 additions & 2 deletions docs/_utils/multiversion.sh
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#! /bin/bash

cd .. && sphinx-multiversion docs/source docs/_build/dirhtml \
--pre-build './docs/_utils/javadoc.sh' \
--pre-build "find . -mindepth 2 -name README.md -execdir mv '{}' index.md ';'"
--pre-build "find . -mindepth 2 -name README.md -execdir mv '{}' index.md ';'" \
--post-build './docs/_utils/javadoc.sh'
1 change: 0 additions & 1 deletion docs/_utils/redirections.yaml

This file was deleted.

Empty file added docs/_utils/redirects.yaml
Empty file.
5 changes: 3 additions & 2 deletions docs/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,12 @@ python = "^3.7"
pyyaml = "6.0"
pygments = "2.2.0"
recommonmark = "0.7.1"
sphinx-scylladb-theme = "~1.2.1"
redirects_cli ="~0.1.2"
sphinx-scylladb-theme = "~1.3.1"
sphinx-sitemap = "2.1.0"
sphinx-autobuild = "2021.3.14"
Sphinx = "4.3.2"
sphinx-multiversion-scylla = "~0.2.11"
sphinx-multiversion-scylla = "~0.2.12"

[build-system]
requires = ["poetry>=0.12"]
Expand Down
7 changes: 1 addition & 6 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
# Set which versions are not released yet.
UNSTABLE_VERSIONS = []
# Set which versions are deprecated
DEPRECATED_VERSIONS = ['']
DEPRECATED_VERSIONS = []

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

# -- Options for redirect extension ---------------------------------------

# Read a YAML dictionary of redirections and generate an HTML file for each
redirects_file = "_utils/redirections.yaml"

# -- Options for multiversion extension ----------------------------------

# Whitelist pattern for tags
Expand Down

0 comments on commit d2e261b

Please sign in to comment.