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
|
from pallets_sphinx_themes import ProjectLink, get_version
# Project --------------------------------------------------------------
project = "Click"
copyright = "2014 Pallets Team"
author = "Pallets Team"
release, version = get_version("Click", version_length=1)
# General --------------------------------------------------------------
master_doc = "index"
extensions = ["sphinx.ext.autodoc", "sphinx.ext.intersphinx", "pallets_sphinx_themes"]
intersphinx_mapping = {"python": ("https://docs.python.org/3/", None)}
# HTML -----------------------------------------------------------------
html_theme = "click"
html_theme_options = {"index_sidebar_logo": False}
html_context = {
"project_links": [
ProjectLink("Donate to Pallets", "https://palletsprojects.com/donate"),
ProjectLink("Click Website", "https://palletsprojects.com/p/click/"),
ProjectLink("PyPI releases", "https://pypi.org/project/Click/"),
ProjectLink("Source Code", "https://github.com/pallets/click/"),
ProjectLink("Issue Tracker", "https://github.com/pallets/click/issues/"),
]
}
html_sidebars = {
"index": ["project.html", "versions.html", "searchbox.html"],
"**": ["localtoc.html", "relations.html", "versions.html", "searchbox.html"],
}
singlehtml_sidebars = {"index": ["project.html", "versions.html", "localtoc.html"]}
html_static_path = ["_static"]
html_favicon = "_static/click-icon.png"
html_logo = "_static/click-logo-sidebar.png"
html_title = "{} Documentation ({})".format(project, version)
html_show_sourcelink = False
html_domain_indices = False
html_experimental_html5_writer = True
# LaTeX ----------------------------------------------------------------
latex_documents = [
(master_doc, "Click.tex", "Click Documentation", "Pallets Team", "manual")
]
# theme compatibility --------------------------------------------------
def setup(app):
from click.testing import CliRunner
orig_invoke = CliRunner.invoke
def invoke(self, *args, **kwargs):
kwargs.pop("prog_name", None)
return orig_invoke(self, *args, **kwargs)
CliRunner.invoke = invoke
|
