mirror of
https://github.com/scylladb/scylladb.git
synced 2026-05-12 19:02:12 +00:00
committed by
Kamil Braun
parent
70f4f8d799
commit
84e073d0ec
@@ -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
|
||||
@@ -21,12 +21,6 @@ ALLSPHINXOPTS := -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(
|
||||
TESTSPHINXOPTS := $(ALLSPHINXOPTS) -W --keep-going
|
||||
PROD_OPTS := -D html_theme_options.collapse_navigation='false' -D html_theme_options.navigation_depth=3 -t $(FLAG) -c $(CONF_PATH)
|
||||
|
||||
|
||||
# Windows variables
|
||||
ifeq ($(OS),Windows_NT)
|
||||
POETRY = $(APPDATA)\Python\Scripts\poetry
|
||||
endif
|
||||
|
||||
.PHONY: all
|
||||
all: dirhtml
|
||||
|
||||
|
||||
@@ -218,3 +218,9 @@ def setup(app: Sphinx):
|
||||
app.connect("builder-inited", AMIInformationDownloader().run)
|
||||
|
||||
app.add_directive("scylladb_aws_images_template", AMIVersionsTemplateDirective)
|
||||
|
||||
return {
|
||||
"version": "0.1",
|
||||
"parallel_read_safe": True,
|
||||
"parallel_write_safe": True,
|
||||
}
|
||||
@@ -181,3 +181,9 @@ def setup(app: Sphinx):
|
||||
)
|
||||
app.connect("builder-inited", db_parser.run)
|
||||
app.add_directive("scylladb_config_template", DBConfigTemplateDirective)
|
||||
|
||||
return {
|
||||
"version": "0.1",
|
||||
"parallel_read_safe": True,
|
||||
"parallel_write_safe": True,
|
||||
}
|
||||
26
docs/conf.py
26
docs/conf.py
@@ -24,7 +24,7 @@ UNSTABLE_VERSIONS = ["master", "branch-5.4"]
|
||||
# Set which versions are deprecated.
|
||||
DEPRECATED_VERSIONS = [""]
|
||||
|
||||
# -- General configuration ------------------------------------------------
|
||||
# -- General configuration
|
||||
|
||||
# Add any Sphinx extension module names here, as strings.
|
||||
extensions = [
|
||||
@@ -66,7 +66,7 @@ rst_prolog = """
|
||||
.. |cql-version| replace:: 3.3.1
|
||||
"""
|
||||
|
||||
# -- 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,11 +74,11 @@ 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 extension ----------------------------------
|
||||
# -- Options for multiversion extension
|
||||
|
||||
# Whitelist pattern for tags
|
||||
smv_tag_whitelist = multiversion_regex_builder(TAGS)
|
||||
@@ -95,7 +95,14 @@ smv_released_pattern = r"^tags/.*$"
|
||||
# Format for versioned output directories inside the build directory
|
||||
smv_outputdir_format = "{ref.name}"
|
||||
|
||||
# -- Options for HTML output ----------------------------------------------
|
||||
# -- Options for scylladb_aws_images extension
|
||||
|
||||
scylladb_aws_images_base_url = "https://s3.amazonaws.com/downloads.scylladb.com"
|
||||
scylladb_aws_images_ami_bucket_directory = "downloads/scylla/aws/ami/"
|
||||
scylladb_aws_images_ami_download_directory = "_data/opensource/aws/ami"
|
||||
scylladb_aws_images_cloudformation_bucket_directory = "downloads/scylla/aws/cloudformation/"
|
||||
|
||||
# -- Options for HTML output
|
||||
|
||||
# The theme to use for pages.
|
||||
html_theme = "sphinx_scylladb_theme"
|
||||
@@ -143,14 +150,7 @@ html_baseurl = BASE_URL
|
||||
# Dictionary of values to pass into the template engine’s context for all pages
|
||||
html_context = {"html_baseurl": html_baseurl}
|
||||
|
||||
# -- Options for scylladb_aws_images -----------------------------
|
||||
|
||||
scylladb_aws_images_base_url = "https://s3.amazonaws.com/downloads.scylladb.com"
|
||||
scylladb_aws_images_ami_bucket_directory = "downloads/scylla/aws/ami/"
|
||||
scylladb_aws_images_ami_download_directory = "_data/opensource/aws/ami"
|
||||
scylladb_aws_images_cloudformation_bucket_directory = "downloads/scylla/aws/cloudformation/"
|
||||
|
||||
# -- Initialize Sphinx ----------------------------------------------
|
||||
# -- Initialize Sphinx
|
||||
def setup(sphinx):
|
||||
warnings.filterwarnings(
|
||||
action="ignore",
|
||||
|
||||
@@ -5,15 +5,15 @@ version = "4.3.0"
|
||||
authors = ["ScyllaDB Contributors"]
|
||||
|
||||
[tool.poetry.dependencies]
|
||||
python = "^3.7"
|
||||
python = "^3.9"
|
||||
pyyaml = "6.0.1"
|
||||
pygments = "2.15.1"
|
||||
recommonmark = "0.7.1"
|
||||
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.10"
|
||||
Sphinx = "7.2.6"
|
||||
sphinx-multiversion-scylla = "~0.3.1"
|
||||
sphinx-markdown-tables = "0.0.15"
|
||||
redirects_cli ="~0.1.2"
|
||||
sphinxcontrib-datatemplates = "^0.9.2"
|
||||
|
||||
Reference in New Issue
Block a user