wtforms-sqlalchemy/docs/conf.py at main · pallets-eco/wtforms-sqlalchemy · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
import os
import sys

from pallets_sphinx_themes import get_version
from pallets_sphinx_themes import ProjectLink

sys.path.insert(0, os.path.abspath(".."))

# -- Project -------------------------------------------------------------------

project = "WTForms-SQLAlchemy"

# -- General -------------------------------------------------------------------

master_doc = "index"
extensions = [
    "sphinx.ext.autodoc",
    "sphinx.ext.intersphinx",
    "sphinx.ext.viewcode",
    "pallets_sphinx_themes",
    "sphinx_issues",
    "sphinxcontrib.log_cabinet",
]
intersphinx_mapping = {
    "python": ("https://docs.python.org/3/", None),
    "WTForms": ("https://wtforms.readthedocs.io/en/stable/", None),
}
copyright = "2020, WTForms Team"
release, version = get_version("WTForms")
exclude_patterns = ["_build"]
pygments_style = "sphinx"

# -- HTML ----------------------------------------------------------------------

html_theme = "werkzeug"
html_context = {
    "project_links": [
        ProjectLink(
            "WTForms documentation", "https://wtforms.readthedocs.io/en/stable/"
        ),
        ProjectLink("PyPI Releases", "https://pypi.org/project/WTForms-SQLAlchemy/"),
        ProjectLink("Source Code", "https://github.com/wtforms/wtforms-sqlalchemy/"),
        ProjectLink(
            "Discord Chat",
            "https://discord.gg/F65P7Z9",
        ),
        ProjectLink(
            "Issue Tracker", "https://github.com/wtforms/wtforms-sqlalchemy/issues/"
        ),
    ]
}
html_sidebars = {
    "index": ["project.html", "localtoc.html", "searchbox.html"],
    "**": ["localtoc.html", "relations.html", "searchbox.html"],
}
singlehtml_sidebars = {"index": ["project.html", "localtoc.html"]}
html_title = f"WTForms SQLAlchemy Documentation ({version})"
html_show_sourcelink = False

# -- LATEX ---------------------------------------------------------------------

latex_documents = [
    (
        "index",
        "WTForms-SQLAlchemy.tex",
        "WTForms-SQLAlchemy Documentation",
        "WTForms Team",
        "manual",
    ),
]