You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
50 lines
1.7 KiB
50 lines
1.7 KiB
from pallets_sphinx_themes import get_version
|
|
from pallets_sphinx_themes import ProjectLink
|
|
|
|
# Project --------------------------------------------------------------
|
|
|
|
project = "MarkupSafe"
|
|
copyright = "2010 Pallets"
|
|
author = "Pallets"
|
|
release, version = get_version("MarkupSafe")
|
|
|
|
# General --------------------------------------------------------------
|
|
|
|
master_doc = "index"
|
|
extensions = [
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.intersphinx",
|
|
"pallets_sphinx_themes",
|
|
"sphinxcontrib.log_cabinet",
|
|
"sphinx_issues",
|
|
]
|
|
intersphinx_mapping = {"python": ("https://docs.python.org/3/", None)}
|
|
issues_github_path = "pallets/markupsafe"
|
|
|
|
# HTML -----------------------------------------------------------------
|
|
|
|
html_theme = "jinja"
|
|
html_theme_options = {"index_sidebar_logo": False}
|
|
html_context = {
|
|
"project_links": [
|
|
ProjectLink("Donate to Pallets", "https://palletsprojects.com/donate"),
|
|
ProjectLink("Website", "https://palletsprojects.com/p/markupsafe/"),
|
|
ProjectLink("PyPI releases", "https://pypi.org/project/MarkupSafe/"),
|
|
ProjectLink("Source Code", "https://github.com/pallets/markupsafe/"),
|
|
ProjectLink("Issue Tracker", "https://github.com/pallets/markupsafe/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"MarkupSafe Documentation ({version})"
|
|
html_show_sourcelink = False
|
|
|
|
# LaTeX ----------------------------------------------------------------
|
|
|
|
latex_documents = [
|
|
(master_doc, f"MarkupSafe-{version}.tex", html_title, author, "manual")
|
|
]
|