diff --git a/docs/Makefile b/docs/Makefile index e5a9318eb6..f0fd61d0e2 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -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 @@ -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 diff --git a/docs/pyproject.toml b/docs/pyproject.toml index dba8a02384..6d2b3bb240 100644 --- a/docs/pyproject.toml +++ b/docs/pyproject.toml @@ -5,16 +5,16 @@ version = "0.9.0" authors = ["ScyllaDB Documentation 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.2" -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.11" +Sphinx = "7.2.6" +sphinx-multiversion-scylla = "~0.3.1" [build-system] requires = ["poetry>=0.12"] diff --git a/docs/source/conf.py b/docs/source/conf.py index b81db1d446..c65e86b5ee 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -11,7 +11,7 @@ from sphinx_scylladb_theme.utils import multiversion_regex_builder sys.path.insert(0, os.path.abspath('..')) -# -- General configuration ------------------------------------------------ +# -- Global variables # Build documentation for the following tags and branches TAGS = ['v0.9.1', 'v0.10.1'] @@ -23,6 +23,8 @@ # Set which versions are deprecated DEPRECATED_VERSIONS = ['v0.9.1'] +# -- General configuration + # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. @@ -71,7 +73,7 @@ def setup(sphinx): lexers['toml'] = TOMLLexer() -# -- 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' @@ -79,7 +81,7 @@ def setup(sphinx): # 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 (set to None to ignore all tags) smv_tag_whitelist = multiversion_regex_builder(TAGS) @@ -95,11 +97,11 @@ def setup(sphinx): # 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. @@ -109,7 +111,6 @@ def setup(sphinx): # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -# html_theme_options = { 'conf_py_path': 'docs/source/', 'default_branch': 'main', @@ -126,7 +127,6 @@ def setup(sphinx): # 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' # Custom sidebar templates, maps document names to template names.