summaryrefslogtreecommitdiff
path: root/docs/conf.py
blob: 3f09b7226f957619124ee750a515946e88995ce8 (plain)
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
from pallets_sphinx_themes import get_version
from pallets_sphinx_themes import ProjectLink

project = "Blinker"
copyright = "2010 Jason Kirtland"
release, version = get_version("blinker", placeholder=None)

extensions = [
    "sphinx.ext.autodoc",
    "pallets_sphinx_themes",
    "sphinx_issues",
]

autoclass_content = "both"
autodoc_member_order = "groupwise"
issues_github_path = "pallets-eco/blinker"

html_theme = "flask"
html_theme_options = {"index_sidebar_logo": False}
html_context = {
    "project_links": [
        ProjectLink("PyPI Releases", "https://pypi.org/project/blinker/"),
        ProjectLink("Source Code", "https://github.com/pallets-eco/blinker/"),
        ProjectLink("Issue Tracker", "https://github.com/pallets-eco/blinker/issues/"),
    ]
}
html_sidebars = {
    "index": ["project.html", "localtoc.html", "searchbox.html", "ethicalads.html"],
    "**": ["localtoc.html", "relations.html", "searchbox.html", "ethicalads.html"],
}
singlehtml_sidebars = {"index": ["project.html", "localtoc.html", "ethicalads.html"]}
html_static_path = ["_static"]
html_logo = "_static/blinker-named.png"
html_title = f"Blinker Documentation ({version})"
html_show_sourcelink = False