Skip to content

Commit 4d6bff9

Browse files
committed
Link to the new referencing doc page.
1 parent 1854b26 commit 4d6bff9

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

docs/referencing.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ JSON (Schema) Referencing
55
The JSON Schema :kw:`$ref` and :kw:`$dynamicRef` keywords allow schema authors to combine multiple schemas (or subschemas) together for reuse or deduplication.
66

77
The `referencing <referencing:index>` library was written in order to provide a simple, well-behaved and well-tested implementation of this kind of reference resolution [1]_.
8-
It has its own documentation, but this page serves as a quick introduction which is tailored more specifically to JSON Schema, and even more specifically to how to configure `referencing <referencing:index>` for use with `Validator` objects in order to customize the behavior of :kw:`$ref` and friends in your schemas.
8+
It has its `own documentation which is worth reviewing <referencing:intro>`, but this page serves as an introduction which is tailored specifically to JSON Schema, and even more specifically to how to configure `referencing <referencing:index>` for use with `Validator` objects in order to customize the behavior of the :kw:`$ref` keyword and friends in your schemas.
99

1010
Configuring `jsonschema` for custom referencing behavior is essentially a two step process:
1111

@@ -65,6 +65,8 @@ You could also confirm your schema is in the registry if you'd like, via `refere
6565

6666
{'type': 'integer'}
6767

68+
For further details, see the `referencing documentation <referencing:intro>`.
69+
6870
Common Scenarios
6971
----------------
7072

docs/requirements.txt

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#
2-
# This file is autogenerated by pip-compile with python 3.10
3-
# To update, run:
2+
# This file is autogenerated by pip-compile with Python 3.11
3+
# by the following command:
44
#
55
# pip-compile --resolver=backtracking docs/requirements.in
66
#
@@ -76,13 +76,13 @@ python-dateutil==2.8.2
7676
# via matplotlib
7777
pyyaml==6.0
7878
# via sphinx-autoapi
79-
referencing==0.24.2
79+
referencing==0.24.3
8080
# via
8181
# jsonschema
8282
# jsonschema-specifications
8383
requests==2.28.2
8484
# via sphinx
85-
rpds-py==0.5.2
85+
rpds-py==0.6.1
8686
# via
8787
# jsonschema
8888
# referencing
@@ -129,8 +129,6 @@ sphinxcontrib-spelling==8.0.0
129129
# via -r docs/requirements.in
130130
sphinxext-opengraph==0.8.1
131131
# via -r docs/requirements.in
132-
typing-extensions==4.5.0
133-
# via astroid
134132
unidecode==1.3.6
135133
# via sphinx-autoapi
136134
urllib3==1.26.14

pyproject.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ dynamic = ["version", "readme"]
3232

3333
dependencies = [
3434
"attrs>=22.2.0",
35-
"jsonschema-specifications>=2023.03.1",
36-
"referencing>=0.24.2",
37-
"rpds-py>=0.5.2",
35+
"jsonschema-specifications>=2023.03.3",
36+
"referencing>=0.24.3",
37+
"rpds-py>=0.6.1",
3838

3939
"importlib_metadata;python_version<'3.8'",
4040
"typing_extensions;python_version<'3.8'",

0 commit comments

Comments
 (0)