werkzeug

1
from pallets_sphinx_themes import get_version
2
from pallets_sphinx_themes import ProjectLink
3

4
# Project --------------------------------------------------------------
5

6
project = "Werkzeug"
7
copyright = "2007 Pallets"
8
author = "Pallets"
9
release, version = get_version("Werkzeug")
10

11
# General --------------------------------------------------------------
12

13
default_role = "code"
14
extensions = [
15
    "sphinx.ext.autodoc",
16
    "sphinx.ext.extlinks",
17
    "sphinx.ext.intersphinx",
18
    "sphinxcontrib.log_cabinet",
19
    "pallets_sphinx_themes",
20
]
21
autoclass_content = "both"
22
autodoc_member_order = "bysource"
23
autodoc_typehints = "description"
24
autodoc_preserve_defaults = True
25
extlinks = {
26
    "issue": ("https://github.com/pallets/werkzeug/issues/%s", "#%s"),
27
    "pr": ("https://github.com/pallets/werkzeug/pull/%s", "#%s"),
28
    "ghsa": ("https://github.com/advisories/%s", "GHSA-%s"),
29
}
30
intersphinx_mapping = {
31
    "python": ("https://docs.python.org/3/", None),
32
}
33

34
# HTML -----------------------------------------------------------------
35

36
html_theme = "werkzeug"
37
html_theme_options = {"index_sidebar_logo": False}
38
html_context = {
39
    "project_links": [
40
        ProjectLink("Donate", "https://palletsprojects.com/donate"),
41
        ProjectLink("PyPI Releases", "https://pypi.org/project/Werkzeug/"),
42
        ProjectLink("Source Code", "https://github.com/pallets/werkzeug/"),
43
        ProjectLink("Issue Tracker", "https://github.com/pallets/werkzeug/issues/"),
44
        ProjectLink("Chat", "https://discord.gg/pallets"),
45
    ]
46
}
47
html_sidebars = {
48
    "index": ["project.html", "localtoc.html", "searchbox.html", "ethicalads.html"],
49
    "**": ["localtoc.html", "relations.html", "searchbox.html", "ethicalads.html"],
50
}
51
singlehtml_sidebars = {"index": ["project.html", "localtoc.html", "ethicalads.html"]}
52
html_static_path = ["_static"]
53
html_favicon = "_static/shortcut-icon.png"
54
html_logo = "_static/werkzeug-vertical.png"
55
html_title = f"Werkzeug Documentation ({version})"
56
html_show_sourcelink = False
57