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.

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

docs: update theme 1.6 #88

Merged
merged 3 commits into from
Jan 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -14,11 +14,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

Expand Down
14 changes: 7 additions & 7 deletions docs/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@ version = "0.1"
authors = ["ScyllaDB Documentation Contributors"]

[tool.poetry.dependencies]
breathe="4.33.1"
python = "^3.7"
pyyaml = "6.0"
breathe="4.35.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"
[tool.poetry.dev-dependencies]
pytest = "5.2"

Expand Down
21 changes: 9 additions & 12 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
from recommonmark.parser import CommonMarkParser
from sphinx_scylladb_theme.utils import multiversion_regex_builder

# -- General configuration ------------------------------------------------
# -- General configuration

sys.path.insert(0, os.path.abspath('../../'))

Expand Down Expand Up @@ -59,12 +59,6 @@
copyright = str(date.today().year) + ', ScyllaDB. All rights reserved.'
author = u'Scylla Project Contributors'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand All @@ -77,16 +71,19 @@
# 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'

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

# -- Options for multiversion extension ----------------------------------
# -- 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
smv_tag_whitelist = multiversion_regex_builder(TAGS)
# Whitelist pattern for branches
Expand All @@ -102,7 +99,7 @@
# Format for versioned output directories inside the build directory
smv_outputdir_format = '{ref.name}'

# -- Options for Doxygen (API Reference) ---------------------------------
# -- Options for Doxygen (API Reference)
breathe_projects = {
'API': "../../doxygen/xml/"
}
Expand Down Expand Up @@ -134,11 +131,11 @@ def generate_doxygen(app):
DOXYGEN_XML_DIR = breathe_projects[breathe_default_project]
_generate_doxygen_rst(DOXYGEN_XML_DIR, app.builder.srcdir + '/api')

# -- 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.
Expand Down