doc: use sphinx-issues to reference issues and prs

Author: azmeuk

doc/changelog.rst

@@ -7,43 +7,43 @@ Changelog
 Added
 ^^^^^
 - Python 3.13 support.
-- Proper Base64 serialization. #31
+- Proper Base64 serialization. :issue:`31`
 - :meth:`~BaseModel.get_field_root_type` supports :data:`~typing.UnionType`.
 
 Changed
 ^^^^^^^
-- :attr:`SearchRequest.attributes <scim2_models.SearchRequest.attributes>` and :attr:`SearchRequest.attributes <scim2_models.SearchRequest.excluded_attributes>` are mutually exclusive. #19
-- :class:`~scim2_models.Schema` ids must be valid URIs. #26
+- :attr:`SearchRequest.attributes <scim2_models.SearchRequest.attributes>` and :attr:`SearchRequest.attributes <scim2_models.SearchRequest.excluded_attributes>` are mutually exclusive. :issue:`19`
+- :class:`~scim2_models.Schema` ids must be valid URIs. :issue:`26`
 
 [0.2.2] - 2024-09-20
 --------------------
 
 Fixed
 ^^^^^
-- :class:`~scim2_models.ListResponse` pydantic discriminator issue introduced with pydantic 2.9.0. #75
-- Extension payloads are not required on response contexts. #77
+- :class:`~scim2_models.ListResponse` pydantic discriminator issue introduced with pydantic 2.9.0. :issue:`75`
+- Extension payloads are not required on response contexts. :issue:`77`
 
 [0.2.1] - 2024-09-06
 --------------------
 
 Fixed
 ^^^^^
-- :attr:`~scim2_models.Resource.external_id` is :data:`scim2_models.CaseExact.true`. #74
+- :attr:`~scim2_models.Resource.external_id` is :data:`scim2_models.CaseExact.true`. :issue:`74`
 
 [0.2.0] - 2024-08-18
 --------------------
 
 Fixed
 ^^^^^
-- Fix the extension mechanism by introducing the :class:`~scim2_models.Extension` class. #60, #63
+- Fix the extension mechanism by introducing the :class:`~scim2_models.Extension` class. :issue:`60`, :issue:`63`
 
 .. note::
 
     ``schema.make_model()`` becomes ``Resource.from_schema(schema)`` or ``Extension.from_schema(schema)``.
 
 Changed
 ^^^^^^^
-- Enable pydantic :attr:`~pydantic.config.ConfigDict.validate_assignment` option. #54
+- Enable pydantic :attr:`~pydantic.config.ConfigDict.validate_assignment` option. :issue:`54`
 
 [0.1.15] - 2024-08-18
 ---------------------
@@ -54,7 +54,7 @@ Added
 
 Fixed
 ^^^^^
-- :class:`scim2_models.Manager` is a :class:`~scim2_models.MultiValuedComplexAttribute`. #62
+- :class:`scim2_models.Manager` is a :class:`~scim2_models.MultiValuedComplexAttribute`. :issue:`62`
 
 Changed
 ^^^^^^^
@@ -76,39 +76,39 @@ Changed
 Fixed
 ^^^^^
 - `get_by_payload` return :data:`None` on invalid payloads
-- instance :meth:`~scim2_models.Resource.model_dump` with multiple extensions #57
+- instance :meth:`~scim2_models.Resource.model_dump` with multiple extensions :issue:`57`
 
 [0.1.13] - 2024-07-15
 ---------------------
 
 Fixed
 ^^^^^
 - Schema dump with context was broken.
-- :attr:`scim2_models.PatchOperation.op` attribute is case insensitive to be compatible with Microsoft Entra. #55
+- :attr:`scim2_models.PatchOperation.op` attribute is case insensitive to be compatible with Microsoft Entra. :issue:`55`
 
 [0.1.12] - 2024-07-11
 ---------------------
 
 Fixed
 ^^^^^
-- Additional bugfixes about attribute case sensitivity #45
-- Dump was broken after sub-model assignments #48
-- Extension attributes dump were ignored #49
-- :class:`~scim2_models.ListResponse` tolerate any schema order #50
+- Additional bugfixes about attribute case sensitivity :issue:`45`
+- Dump was broken after sub-model assignments :issue:`48`
+- Extension attributes dump were ignored :issue:`49`
+- :class:`~scim2_models.ListResponse` tolerate any schema order :issue:`50`
 
 [0.1.11] - 2024-07-02
 ---------------------
 
 Fixed
 ^^^^^
-- Attributes are case insensitive #39
+- Attributes are case insensitive :issue:`39`
 
 [0.1.10] - 2024-06-30
 ---------------------
 
 Added
 ^^^^^
-- Export resource models with :data:`~scim2_models.Resource.to_schema` #7
+- Export resource models with :data:`~scim2_models.Resource.to_schema` :issue:`7`
 
 [0.1.9] - 2024-06-29
 --------------------
@@ -127,7 +127,7 @@ Fixed
 
 Added
 ^^^^^
-- Dynamic pydantic model creation from SCIM schemas. #6
+- Dynamic pydantic model creation from SCIM schemas. :issue:`6`
 
 Changed
 ^^^^^^^
@@ -136,7 +136,7 @@ Changed
 Fix
 ^^^
 - Allow relative URLs in :data:`~scim2_models.Reference`.
-- Models with multiples extensions could not be initialized. #37
+- Models with multiples extensions could not be initialized. :issue:`37`
 
 [0.1.7] - 2024-06-16
 --------------------
@@ -149,7 +149,7 @@ Added
 
 Fix
 ^^^
-- Add missing default values. #33
+- Add missing default values. :issue:`33`
 
 [0.1.6] - 2024-06-06
 --------------------

doc/conf.py

@@ -16,6 +16,7 @@
     "sphinx.ext.todo",
     "sphinx.ext.viewcode",
     "sphinxcontrib.autodoc_pydantic",
+    "sphinx_issues",
     "sphinx_togglebutton",
     "myst_parser",
 ]
@@ -86,3 +87,7 @@
 doctest_global_setup = """
 from scim2_models import *
 """
+
+# -- Options for sphinx-issues -------------------------------------
+
+issues_github_path = "python-scim/scim2-models"

pyproject.toml

@@ -48,6 +48,7 @@ doc = [
     "myst-parser>=3.0.1",
     "shibuya>=2024.5.15",
     "sphinx>=7.3.7",
+    "sphinx-issues >= 5.0.0",
     "sphinx-togglebutton>=0.3.2",
 ]