20477c6357
* update pre-commit hooks * add devcontainer * show url in publish environment * update actions versions * separate typing job * use dependabot grouped updates ignore upload/download-artifact until slsa updates * use sphinx.ext.extlinks instead of sphinx-issues * update editorconfig * update gitignore * update .readthedocs.yaml * license is txt, readme is md * use pyproject.toml and flit_core instead of setuptools add typed classifier add pyright config simplify urls * tox builds docs in place * add tox env to update all dev dependencies * update issue and pr templates * simplify matrix
55 lines
1.8 KiB
Python
55 lines
1.8 KiB
Python
from pallets_sphinx_themes import get_version
|
|
from pallets_sphinx_themes import ProjectLink
|
|
|
|
# Project --------------------------------------------------------------
|
|
|
|
project = "Jinja"
|
|
copyright = "2007 Pallets"
|
|
author = "Pallets"
|
|
release, version = get_version("Jinja2")
|
|
|
|
# General --------------------------------------------------------------
|
|
|
|
default_role = "code"
|
|
extensions = [
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.extlinks",
|
|
"sphinx.ext.intersphinx",
|
|
"sphinxcontrib.log_cabinet",
|
|
"pallets_sphinx_themes",
|
|
]
|
|
autodoc_member_order = "bysource"
|
|
autodoc_typehints = "description"
|
|
autodoc_preserve_defaults = True
|
|
extlinks = {
|
|
"issue": ("https://github.com/pallets/jinja/issues/%s", "#%s"),
|
|
"pr": ("https://github.com/pallets/jinja/pull/%s", "#%s"),
|
|
}
|
|
intersphinx_mapping = {
|
|
"python": ("https://docs.python.org/3/", None),
|
|
}
|
|
|
|
# HTML -----------------------------------------------------------------
|
|
|
|
html_theme = "jinja"
|
|
html_theme_options = {"index_sidebar_logo": False}
|
|
html_context = {
|
|
"project_links": [
|
|
ProjectLink("Donate", "https://palletsprojects.com/donate"),
|
|
ProjectLink("PyPI Releases", "https://pypi.org/project/Jinja2/"),
|
|
ProjectLink("Source Code", "https://github.com/pallets/jinja/"),
|
|
ProjectLink("Issue Tracker", "https://github.com/pallets/jinja/issues/"),
|
|
ProjectLink("Chat", "https://discord.gg/pallets"),
|
|
]
|
|
}
|
|
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_favicon = "_static/jinja-logo-sidebar.png"
|
|
html_logo = "_static/jinja-logo-sidebar.png"
|
|
html_title = f"Jinja Documentation ({version})"
|
|
html_show_sourcelink = False
|