From 18402fd4e10caf931e2df49080722ad95c9903bf Mon Sep 17 00:00:00 2001 From: David Garcia Date: Tue, 19 Dec 2023 10:52:10 +0000 Subject: [PATCH] docs: update theme 1.6 --- docs/Makefile | 8 +------- docs/pyproject.toml | 12 ++++++------ docs/source/conf.py | 12 ++++++------ 3 files changed, 13 insertions(+), 19 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index 362259bffc8..09ea360f8a3 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,6 +1,6 @@ # You can set these variables from the command line. POETRY = poetry -SPHINXOPTS = +SPHINXOPTS = -j auto SPHINXBUILD = $(POETRY) run sphinx-build PAPER = BUILDDIR = _build @@ -13,12 +13,6 @@ ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(S TESTSPHINXOPTS = $(ALLSPHINXOPTS) -W --keep-going I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCEDIR) -# Windows variables -ifeq ($(OS),Windows_NT) - POETRY = $(APPDATA)\Python\Scripts\poetry -endif - - .PHONY: all all: dirhtml diff --git a/docs/pyproject.toml b/docs/pyproject.toml index c7d7239d705..284caf936b0 100644 --- a/docs/pyproject.toml +++ b/docs/pyproject.toml @@ -5,16 +5,16 @@ description = "ScyllaDB Java Driver" authors = ["Java Driver Contributors"] [tool.poetry.dependencies] -python = "^3.7" -pyyaml = "6.0" +python = "^3.9" +pyyaml = "6.0.1" pygments = "2.15.1" recommonmark = "0.7.1" redirects_cli ="~0.1.3" -sphinx-scylladb-theme = "~1.5.1" -sphinx-sitemap = "2.5.0" +sphinx-scylladb-theme = "~1.6.1" +sphinx-sitemap = "2.5.1" sphinx-autobuild = "2021.3.14" -Sphinx = "4.3.2" -sphinx-multiversion-scylla = "~0.2.12" +Sphinx = "7.2.6" +sphinx-multiversion-scylla = "~0.3.1" setuptools = "^65.6.3" wheel = "^0.38.4" diff --git a/docs/source/conf.py b/docs/source/conf.py index afbfb01ac7d..5ecb3d68c6b 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -9,7 +9,7 @@ from sphinx_scylladb_theme.utils import multiversion_regex_builder from redirects_cli import cli as redirects_cli -# -- General configuration ------------------------------------------------ +# -- General configuration # Build documentation for the following tags and branches TAGS = [] @@ -66,7 +66,7 @@ # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = True -# -- 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' @@ -74,7 +74,7 @@ # Prefix added to all the URLs generated in the 404 page. notfound_urls_prefix = '' -# -- Options for multiversion extension ---------------------------------- +# -- Options for multiversion extension # Whitelist pattern for tags smv_tag_whitelist = multiversion_regex_builder(TAGS) @@ -91,11 +91,11 @@ # Format for versioned output directories inside the build directory smv_outputdir_format = '{ref.name}' -# -- Options for sitemap extension --------------------------------------- +# -- Options for sitemap extension sitemap_url_scheme = "/stable/{link}" -# -- 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. @@ -138,7 +138,7 @@ # Dictionary of values to pass into the template engine’s context for all pages html_context = {'html_baseurl': html_baseurl} -# -- Initialize Sphinx ---------------------------------------------- +# -- Initialize Sphinx class CustomCommonMarkParser(CommonMarkParser):