orbit-oss/flask
4
5
Fork 2
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

use sphinx.ext.extlinks instead of sphinx-issues

Browse source
This commit is contained in:
David Lord 2024-04-06 16:32:57 -07:00
parent 9080b95cc8
commit beeecc5bf5
No known key found for this signature in database
GPG key ID: 7A1C87E3F5BC42A8
1 changed files with 9 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

17
docs/conf.py
View file

@ -11,16 +11,22 @@ release, version = get_version("Flask")
# General -------------------------------------------------------------- # General --------------------------------------------------------------
master_doc = "index" default_role = "code"
extensions = [ extensions = [
"sphinx.ext.autodoc", "sphinx.ext.autodoc",
"sphinx.ext.extlinks",
"sphinx.ext.intersphinx", "sphinx.ext.intersphinx",
"sphinxcontrib.log_cabinet", "sphinxcontrib.log_cabinet",
"pallets_sphinx_themes",
"sphinx_issues",
"sphinx_tabs.tabs", "sphinx_tabs.tabs",
"pallets_sphinx_themes",
] ]
autodoc_member_order = "bysource"
autodoc_typehints = "description" autodoc_typehints = "description"
autodoc_preserve_defaults = True
extlinks = {
"issue": ("https://github.com/pallets/flask/issues/%s", "#%s"),
"pr": ("https://github.com/pallets/flask/pull/%s", "#%s"),
}
intersphinx_mapping = { intersphinx_mapping = {
"python": ("https://docs.python.org/3/", None), "python": ("https://docs.python.org/3/", None),
"werkzeug": ("https://werkzeug.palletsprojects.com/", None), "werkzeug": ("https://werkzeug.palletsprojects.com/", None),
@ -31,7 +37,6 @@ intersphinx_mapping = {
"wtforms": ("https://wtforms.readthedocs.io/", None), "wtforms": ("https://wtforms.readthedocs.io/", None),
"blinker": ("https://blinker.readthedocs.io/", None), "blinker": ("https://blinker.readthedocs.io/", None),
} }
issues_github_path = "pallets/flask"
# HTML ----------------------------------------------------------------- # HTML -----------------------------------------------------------------
@ -57,10 +62,6 @@ html_logo = "_static/flask-vertical.png"
html_title = f"Flask Documentation ({version})" html_title = f"Flask Documentation ({version})"
html_show_sourcelink = False html_show_sourcelink = False
# LaTeX ----------------------------------------------------------------
latex_documents = [(master_doc, f"Flask-{version}.tex", html_title, author, "manual")]
# Local Extensions ----------------------------------------------------- # Local Extensions -----------------------------------------------------