Skip to content

feat: use sphinx-issues for linking #218

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
takluyver merged 4 commits into from
Jun 7, 2025
+6 −7
Merged

feat: use sphinx-issues for linking #218

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eac4e3c
feat: add extlinks for issue and pull
shenxianpeng Jun 3, 2025
717d01f
fix: update conf.py and clanglog.rst
shenxianpeng Jun 3, 2025
8566150
use sphinx-issues to align with other pypa projects
shenxianpeng Jun 3, 2025
70cabb0
remove extlinks ext and fix ci failure
shenxianpeng Jun 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 (PR :pr:`199`).
- Clean up the ``_in_process`` directory inside the package from ``sys.path``
before imporing the backend (#193).
before imporing the backend (PR :pr:`193`).

v1.1
----
Expand Down Expand Up @@ -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
-----
Expand Down
6 changes: 2 additions & 4 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
"sphinx.ext.extlinks",
"sphinx_issues",
]

toc_object_entries_show_parents = "hide"
Expand Down Expand Up @@ -46,6 +46,4 @@
# -- Options for extlinks ----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html#configuration

extlinks = {
"pypi": ("https://pypi.org/project/%s", "%s"),
}
issues_github_path = "pypa/pyproject-hooks"
1 change: 1 addition & 0 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
furo
sphinx
sphinx-issues
Loading