From beeecc5bf5adb859888cb7a2059035311006c14b Mon Sep 17 00:00:00 2001 From: David Lord Date: Sat, 6 Apr 2024 16:32:57 -0700 Subject: [PATCH] use sphinx.ext.extlinks instead of sphinx-issues --- docs/conf.py | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 771a7228..25b8f004 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -11,16 +11,22 @@ release, version = get_version("Flask") # General -------------------------------------------------------------- -master_doc = "index" +default_role = "code" extensions = [ "sphinx.ext.autodoc", + "sphinx.ext.extlinks", "sphinx.ext.intersphinx", "sphinxcontrib.log_cabinet", - "pallets_sphinx_themes", - "sphinx_issues", "sphinx_tabs.tabs", + "pallets_sphinx_themes", ] +autodoc_member_order = "bysource" 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 = { "python": ("https://docs.python.org/3/", None), "werkzeug": ("https://werkzeug.palletsprojects.com/", None), @@ -31,7 +37,6 @@ intersphinx_mapping = { "wtforms": ("https://wtforms.readthedocs.io/", None), "blinker": ("https://blinker.readthedocs.io/", None), } -issues_github_path = "pallets/flask" # HTML ----------------------------------------------------------------- @@ -57,10 +62,6 @@ html_logo = "_static/flask-vertical.png" html_title = f"Flask Documentation ({version})" html_show_sourcelink = False -# LaTeX ---------------------------------------------------------------- - -latex_documents = [(master_doc, f"Flask-{version}.tex", html_title, author, "manual")] - # Local Extensions -----------------------------------------------------