Skip to content

Commit 10093cd

Browse files
authored
Merge pull request #218 from shenxianpeng/update-docs
feat: use `sphinx-issues` for linking
2 parents e89c52f + 70cabb0 commit 10093cd

File tree

3 files changed

+6
-7
lines changed

3 files changed

+6
-7
lines changed

docs/changelog.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ v1.2
55
----
66

77
- Improve interoperability with ``importlib.metadata``, fixing a regression
8-
in setuptools compatibility in 1.1 (#199).
8+
in setuptools compatibility in 1.1 (PR :pr:`199`).
99
- Clean up the ``_in_process`` directory inside the package from ``sys.path``
10-
before imporing the backend (#193).
10+
before imporing the backend (PR :pr:`193`).
1111

1212
v1.1
1313
----
@@ -39,7 +39,7 @@ v0.13
3939

4040
- Remove support for end-of-life Pythons. Now requires Python3.6+.
4141
- Remove support for ``toml`` package. Now requires ``tomli``.
42-
- Rely on preferred "files" API on Python 3.9 and later (#140).
42+
- Rely on preferred "files" API on Python 3.9 and later (:issue:`140`).
4343

4444
v0.12
4545
-----

docs/conf.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
extensions = [
1717
"sphinx.ext.autodoc",
1818
"sphinx.ext.intersphinx",
19-
"sphinx.ext.extlinks",
19+
"sphinx_issues",
2020
]
2121

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

49-
extlinks = {
50-
"pypi": ("https://pypi.org/project/%s", "%s"),
51-
}
49+
issues_github_path = "pypa/pyproject-hooks"

docs/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
furo
22
sphinx
3+
sphinx-issues

0 commit comments

Comments
 (0)