Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update theme 1.6 #29

Merged
merged 1 commit into from
Oct 12, 2023
Merged

docs: update theme 1.6 #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 1 addition & 6 deletions docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Global variables
# You can set these variables from the command line.
POETRY = poetry
SPHINXOPTS =
SPHINXOPTS = -j auto
SPHINXBUILD = $(POETRY) run sphinx-build
PAPER =
BUILDDIR = _build
Expand All @@ -13,11 +13,6 @@ PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCEDIR)
TESTSPHINXOPTS = $(ALLSPHINXOPTS) -W --keep-going

# Windows variables
ifeq ($(OS),Windows_NT)
POETRY = $(APPDATA)\Python\Scripts\poetry
endif

.PHONY: all
all: dirhtml

Expand Down
12 changes: 6 additions & 6 deletions docs/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@ version = "1.0"
authors = ["ScyllaDB Documentation Contributors"]

[tool.poetry.dependencies]
python = "^3.7"
python = "^3.9"
pyyaml = "6.0.1"
pygments = "2.15.1"
sphinx-scylladb-theme = "~1.5.1"
sphinx-scylladb-theme = "~1.6.1"
sphinx-autobuild = "2021.3.14"
Sphinx = "4.3.2"
sphinx-multiversion-scylla = "~0.2.11"
sphinx-sitemap = "2.5.0"
Sphinx = "7.2.6"
sphinx-multiversion-scylla = "~0.3.1"
sphinx-sitemap = "2.5.1"
redirects_cli ="~0.1.3"
myst-parser = "0.18.1"
myst-parser = "2.0.0"

[build-system]
requires = ["poetry>=0.12"]
Expand Down
15 changes: 7 additions & 8 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
# -*- coding: utf-8 -*-
import os
import sys
from datetime import date

from sphinx_scylladb_theme.utils import multiversion_regex_builder

# -- General configuration ------------------------------------------------
# -- Global variables

# Build documentation for the following tags and branches
TAGS = []
Expand All @@ -17,6 +15,8 @@
# Set which versions are deprecated
DEPRECATED_VERSIONS = []

# -- General configuration

# Add any Sphinx extension module names here, as strings.
extensions = [
"sphinx.ext.autodoc",
Expand Down Expand Up @@ -52,7 +52,7 @@
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# -- Options for HTML output ----------------------------------------------
# -- Options for HTML output

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
Expand All @@ -78,7 +78,6 @@
# If not None, a 'Last updated on:' timestamp is inserted at every page
# bottom, using the given strftime format.
# The empty string is equivalent to '%b %d, %Y'.
#
html_last_updated_fmt = '%d %B %Y'

# If true, SmartyPants will be used to convert quotes and dashes to
Expand All @@ -103,19 +102,19 @@
# They are copied to the output’s _static directory.
html_static_path = ["_static"]

# -- Options for not found extension -------------------------------------------
# -- Options for not found extension

# Template used to render the 404.html generated by this extension.
notfound_template = "404.html"

# Prefix added to all the URLs generated in the 404 page.
notfound_urls_prefix = ""

# -- Options for sitemap extension ---------------------------------------
# -- Options for sitemap extension

sitemap_url_scheme = "/stable/{link}"

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

# Whitelist pattern for tags
smv_tag_whitelist = multiversion_regex_builder(TAGS)
Expand Down