Changeset View
Changeset View
Standalone View
Standalone View
swh/docs/sphinx/conf.py
Show All 25 Lines | extensions = [ | ||||
"sphinxcontrib.programoutput", | "sphinxcontrib.programoutput", | ||||
"sphinx.ext.viewcode", | "sphinx.ext.viewcode", | ||||
"sphinx_tabs.tabs", | "sphinx_tabs.tabs", | ||||
"sphinx_rtd_theme", | "sphinx_rtd_theme", | ||||
"sphinx.ext.graphviz", | "sphinx.ext.graphviz", | ||||
"sphinx_click.ext", | "sphinx_click.ext", | ||||
"myst_parser", | "myst_parser", | ||||
"sphinx.ext.todo", | "sphinx.ext.todo", | ||||
"sphinx_reredirects", | |||||
"swh.docs.sphinx.view_in_phabricator", | "swh.docs.sphinx.view_in_phabricator", | ||||
] | ] | ||||
# Add any paths that contain templates here, relative to this directory. | # Add any paths that contain templates here, relative to this directory. | ||||
templates_path = ["_templates"] | templates_path = ["_templates"] | ||||
# The suffix(es) of source filenames. | # The suffix(es) of source filenames. | ||||
# You can specify multiple suffix as a list of string: | # You can specify multiple suffix as a list of string: | ||||
▲ Show 20 Lines • Show All 78 Lines • ▼ Show 20 Lines | |||||
# If not None, a 'Last updated on:' timestamp is inserted at every page | # If not None, a 'Last updated on:' timestamp is inserted at every page | ||||
# bottom, using the given strftime format. | # bottom, using the given strftime format. | ||||
# The empty string is equivalent to '%b %d, %Y'. | # The empty string is equivalent to '%b %d, %Y'. | ||||
html_last_updated_fmt = "%Y-%m-%d %H:%M:%S %Z" | html_last_updated_fmt = "%Y-%m-%d %H:%M:%S %Z" | ||||
# refer to the Python standard library. | # refer to the Python standard library. | ||||
intersphinx_mapping = {"python": ("https://docs.python.org/3", None)} | intersphinx_mapping = {"python": ("https://docs.python.org/3", None)} | ||||
# Redirects for pages that were moved, so we don't break external links. | |||||
# Uses sphinx-reredirects | |||||
redirects = { | |||||
"swh-deposit/spec-api": "api/api-documentation.html", | |||||
"swh-deposit/metadata": "api/metadata.html", | |||||
"swh-deposit/specs/blueprint": "../api/use-cases.html", | |||||
"swh-deposit/user-manual": "api/user-manual.html", | |||||
} | |||||
# -- autodoc configuration ---------------------------------------------- | # -- autodoc configuration ---------------------------------------------- | ||||
autodoc_default_flags = [ | autodoc_default_flags = [ | ||||
"members", | "members", | ||||
"undoc-members", | "undoc-members", | ||||
"private-members", | "private-members", | ||||
"special-members", | "special-members", | ||||
] | ] | ||||
Show All 35 Lines |