doc: use sphinx-issues to reference issues and prs

azmeuk · azmeuk · commit 6f77228819ed · 2024-11-01T21:46:20.000+01:00
diff --git a/doc/conf.py b/doc/conf.py
@@ -17,6 +17,7 @@
     "sphinx.ext.todo",
     "sphinx.ext.viewcode",
     "sphinx_click",
+    "sphinx_issues",
 ]
 
 templates_path = ["_templates"]
@@ -79,3 +80,7 @@
         "Miscellaneous",
     )
 ]
+
+# -- Options for sphinx-issues -------------------------------------
+
+issues_github_path = "python-scim/scim2-cli"
diff --git a/pyproject.toml b/pyproject.toml
@@ -51,6 +51,7 @@ doc = [
     "shibuya>=2024.5.15",
     "sphinx>=7.3.7",
     "sphinx-click>=6.0.0",
+    "sphinx-issues >= 5.0.0",
     "myst-parser>=3.0.1",
 ]
 
diff --git a/uv.lock b/uv.lock

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@`
`17`	`17`	`"sphinx.ext.todo",`
`18`	`18`	`"sphinx.ext.viewcode",`
`19`	`19`	`"sphinx_click",`
	`20`	`+ "sphinx_issues",`
`20`	`21`	`]`
`21`	`22`
`22`	`23`	`templates_path = ["_templates"]`
`@@ -79,3 +80,7 @@`
`79`	`80`	`"Miscellaneous",`
`80`	`81`	`)`
`81`	`82`	`]`
	`83`	`+`
	`84`	`+# -- Options for sphinx-issues -------------------------------------`
	`85`	`+`
	`86`	`+issues_github_path = "python-scim/scim2-cli"`