From eac4e3c72e9b071e723c7407dee4d4107b9435ff Mon Sep 17 00:00:00 2001 From: shenxianpeng Date: Tue, 3 Jun 2025 07:14:09 +0000 Subject: [PATCH 1/4] feat: add extlinks for issue and pull --- docs/conf.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 222b257..4acea56 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,4 +48,6 @@ extlinks = { "pypi": ("https://pypi.org/project/%s", "%s"), + "issue": ("https://github.com/pypa/pyproject-hooks/issues/%s", "#%s"), + "pull": ("https://github.com/pypa/pyproject-hooks/pull/%s", "PR #%s"), } From 717d01f19ca383be263a4424b9dafc895fb73cd8 Mon Sep 17 00:00:00 2001 From: shenxianpeng Date: Tue, 3 Jun 2025 08:19:43 +0000 Subject: [PATCH 2/4] fix: update conf.py and clanglog.rst --- docs/changelog.rst | 6 +++--- docs/conf.py | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index 4b68795..9999702 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -5,9 +5,9 @@ v1.2 ---- - Improve interoperability with ``importlib.metadata``, fixing a regression - in setuptools compatibility in 1.1 (#199). + in setuptools compatibility in 1.1 (:pull:`199`). - Clean up the ``_in_process`` directory inside the package from ``sys.path`` - before imporing the backend (#193). + before imporing the backend (:pull:`193`). v1.1 ---- @@ -39,7 +39,7 @@ v0.13 - Remove support for end-of-life Pythons. Now requires Python3.6+. - Remove support for ``toml`` package. Now requires ``tomli``. -- Rely on preferred "files" API on Python 3.9 and later (#140). +- Rely on preferred "files" API on Python 3.9 and later (:issue:`140`). v0.12 ----- diff --git a/docs/conf.py b/docs/conf.py index 4acea56..d556bb8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -49,5 +49,5 @@ extlinks = { "pypi": ("https://pypi.org/project/%s", "%s"), "issue": ("https://github.com/pypa/pyproject-hooks/issues/%s", "#%s"), - "pull": ("https://github.com/pypa/pyproject-hooks/pull/%s", "PR #%s"), + "pull": ("https://github.com/pypa/pyproject-hooks/pull/%s", "#%s"), } From 8566150b9a9e88876a7b7321a6314eebff7cdd01 Mon Sep 17 00:00:00 2001 From: shenxianpeng Date: Tue, 3 Jun 2025 08:52:22 +0000 Subject: [PATCH 3/4] use sphinx-issues to align with other pypa projects --- docs/changelog.rst | 4 ++-- docs/conf.py | 7 ++----- docs/requirements.txt | 1 + 3 files changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index 9999702..574a3e1 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -5,9 +5,9 @@ v1.2 ---- - Improve interoperability with ``importlib.metadata``, fixing a regression - in setuptools compatibility in 1.1 (:pull:`199`). + in setuptools compatibility in 1.1 (PR :pr:`199`). - Clean up the ``_in_process`` directory inside the package from ``sys.path`` - before imporing the backend (:pull:`193`). + before imporing the backend (PR :pr:`193`). v1.1 ---- diff --git a/docs/conf.py b/docs/conf.py index d556bb8..271e056 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -17,6 +17,7 @@ "sphinx.ext.autodoc", "sphinx.ext.intersphinx", "sphinx.ext.extlinks", + "sphinx_issues", ] toc_object_entries_show_parents = "hide" @@ -46,8 +47,4 @@ # -- Options for extlinks ---------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html#configuration -extlinks = { - "pypi": ("https://pypi.org/project/%s", "%s"), - "issue": ("https://github.com/pypa/pyproject-hooks/issues/%s", "#%s"), - "pull": ("https://github.com/pypa/pyproject-hooks/pull/%s", "#%s"), -} +issues_github_path = 'pypa/pyproject-hooks' diff --git a/docs/requirements.txt b/docs/requirements.txt index 70b8bab..ac7c1d8 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,3 @@ furo sphinx +sphinx-issues From 70cabb0bb8d656afae7b245f0f7201de2865964b Mon Sep 17 00:00:00 2001 From: shenxianpeng Date: Sat, 7 Jun 2025 18:43:57 +0300 Subject: [PATCH 4/4] remove extlinks ext and fix ci failure --- docs/conf.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 271e056..015f389 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -16,7 +16,6 @@ extensions = [ "sphinx.ext.autodoc", "sphinx.ext.intersphinx", - "sphinx.ext.extlinks", "sphinx_issues", ] @@ -47,4 +46,4 @@ # -- Options for extlinks ---------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html#configuration -issues_github_path = 'pypa/pyproject-hooks' +issues_github_path = "pypa/pyproject-hooks"