python-click/docs/conf.py

48 lines
1.7 KiB
Python
Raw Normal View History

2018-09-06 20:55:10 +02:00
from pallets_sphinx_themes import ProjectLink, get_version
2014-10-16 20:40:34 +02:00
2018-09-06 20:55:10 +02:00
# Project --------------------------------------------------------------
2014-10-16 20:40:34 +02:00
2018-09-06 20:55:10 +02:00
project = "Click"
copyright = "2014 Pallets Team"
author = "Pallets Team"
release, version = get_version("Click")
2014-10-16 20:40:34 +02:00
2018-09-06 20:55:10 +02:00
# General --------------------------------------------------------------
2014-10-16 20:40:34 +02:00
2018-09-06 20:55:10 +02:00
master_doc = "index"
extensions = ["sphinx.ext.autodoc", "sphinx.ext.intersphinx", "pallets_sphinx_themes"]
intersphinx_mapping = {"python": ("https://docs.python.org/3/", None)}
2014-10-16 20:40:34 +02:00
2018-09-06 20:55:10 +02:00
# HTML -----------------------------------------------------------------
2014-10-16 20:40:34 +02:00
2018-09-06 20:55:10 +02:00
html_theme = "click"
2014-10-16 20:40:34 +02:00
html_theme_options = {
2018-09-06 20:55:10 +02:00
"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/"),
]
2014-10-16 20:40:34 +02:00
}
html_sidebars = {
2018-09-06 20:55:10 +02:00
"index": ["project.html", "versions.html", "searchbox.html"],
"**": ["localtoc.html", "relations.html", "versions.html", "searchbox.html"],
2014-10-16 20:40:34 +02:00
}
2018-09-06 20:55:10 +02:00
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_show_sourcelink = False
html_domain_indices = False
html_experimental_html5_writer = True
2014-10-16 20:40:34 +02:00
2018-09-06 20:55:10 +02:00
# LaTeX ----------------------------------------------------------------
2014-10-16 20:40:34 +02:00
latex_documents = [
2018-09-06 20:55:10 +02:00
(master_doc, "Click.tex", "Click Documentation", "Pallets Team", "manual")
2014-10-16 20:40:34 +02:00
]