Skip to content

Commit 8ffcedc

Browse files
committed
doc: update sibling project links
1 parent 42d4b75 commit 8ffcedc

1 file changed

Lines changed: 70 additions & 16 deletions

File tree

‎doc/conf.py‎

Lines changed: 70 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,78 @@
4646
intersphinx_mapping = {
4747
"python": ("https://docs.python.org/3", None),
4848
"scim2_models": ("https://scim2-models.readthedocs.io/en/latest/", None),
49+
"scim2_tester": ("https://scim2-tester.readthedocs.io/en/latest/", None),
50+
"scim2_cli": ("https://scim2-cli.readthedocs.io/en/latest/", None),
4951
"werkzeug": ("https://werkzeug.palletsprojects.com", None),
5052
}
5153

54+
# -- Sibling projects ------------------------------------------------------
55+
56+
# Kept identical in the scim2-models, scim2-client, scim2-cli and scim2-tester
57+
# documentations, so that any divergence shows up in a diff.
58+
NAV_LINKS = [
59+
{
60+
"title": "Libraries",
61+
"children": [
62+
{
63+
"title": "scim2-models",
64+
"url": "https://scim2-models.readthedocs.io",
65+
"summary": "SCIM resources and messages as Pydantic models",
66+
},
67+
{
68+
"title": "scim2-client",
69+
"url": "https://scim2-client.readthedocs.io",
70+
"summary": "Pythonically build SCIM requests and parse SCIM responses",
71+
},
72+
],
73+
},
74+
{
75+
"title": "Tools",
76+
"children": [
77+
{
78+
"title": "scim2-tester",
79+
"url": "https://scim2-tester.readthedocs.io",
80+
"summary": "Check a SCIM server for RFC compliance",
81+
},
82+
{
83+
"title": "scim2-cli",
84+
"url": "https://scim2-cli.readthedocs.io",
85+
"summary": "Query a SCIM server from the command line",
86+
},
87+
{
88+
"title": "scim2-server",
89+
"url": "https://github.com/python-scim/scim2-server",
90+
"summary": "A lightweight SCIM2 server prototype",
91+
},
92+
{
93+
"title": "pytest-scim2-server",
94+
"url": "https://github.com/pytest-dev/pytest-scim2-server",
95+
"summary": "A SCIM2 server fixture for pytest",
96+
},
97+
],
98+
},
99+
{
100+
"title": "Integrations",
101+
"children": [
102+
{
103+
"title": "scim2-flask",
104+
"url": "https://scim2-flask.readthedocs.io",
105+
"summary": "Painless SCIM integration for Flask",
106+
},
107+
{
108+
"title": "scim2-django",
109+
"url": "https://scim2-django.readthedocs.io",
110+
"summary": "Painless SCIM integration for Django",
111+
},
112+
{
113+
"title": "scim2-fastapi",
114+
"url": "https://scim2-fastapi.readthedocs.io",
115+
"summary": "Painless SCIM integration for FastAPI",
116+
},
117+
],
118+
},
119+
]
120+
52121
# -- Options for HTML output ----------------------------------------------
53122

54123
html_theme = "shibuya"
@@ -60,22 +129,7 @@
60129
"accent_color": "lime",
61130
"github_url": "https://github.com/python-scim/scim2-client",
62131
"mastodon_url": "https://toot.aquilenet.fr/@yaal",
63-
"nav_links": [
64-
{"title": "scim2-models", "url": "https://scim2-models.readthedocs.io"},
65-
{"title": "scim2-tester", "url": "https://scim2-tester.readthedocs.io"},
66-
{
67-
"title": "scim2-cli",
68-
"url": "https://scim2-cli.readthedocs.io",
69-
},
70-
{
71-
"title": "scim2-server",
72-
"url": "https://github.com/python-scim/scim2-server",
73-
},
74-
{
75-
"title": "pytest-scim2-server",
76-
"url": "https://github.com/pytest-dev/pytest-scim2-server",
77-
},
78-
],
132+
"nav_links": NAV_LINKS,
79133
}
80134
html_context = {
81135
"source_type": "github",

0 commit comments

Comments
 (0)