summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJulian Berman <Julian@GrayVines.com>2023-03-09 15:29:51 -0500
committerJulian Berman <Julian@GrayVines.com>2023-03-09 15:29:51 -0500
commit4d6bff9498ecc9767ef0b8c3ba87a1157c6edd26 (patch)
tree696181bb68580d7f2bd3941df05f26a45716fcf2
parent1854b26916d79845673211f731a7fe6dde932232 (diff)
downloadjsonschema-4d6bff9498ecc9767ef0b8c3ba87a1157c6edd26.tar.gz
Link to the new referencing doc page.
-rw-r--r--docs/referencing.rst4
-rw-r--r--docs/requirements.txt10
-rw-r--r--pyproject.toml6
3 files changed, 10 insertions, 10 deletions
diff --git a/docs/referencing.rst b/docs/referencing.rst
index fc95e0d..e3f0e7f 100644
--- a/docs/referencing.rst
+++ b/docs/referencing.rst
@@ -5,7 +5,7 @@ JSON (Schema) Referencing
The JSON Schema :kw:`$ref` and :kw:`$dynamicRef` keywords allow schema authors to combine multiple schemas (or subschemas) together for reuse or deduplication.
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]_.
-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.
+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.
Configuring `jsonschema` for custom referencing behavior is essentially a two step process:
@@ -65,6 +65,8 @@ You could also confirm your schema is in the registry if you'd like, via `refere
{'type': 'integer'}
+For further details, see the `referencing documentation <referencing:intro>`.
+
Common Scenarios
----------------
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 3305990..7c64b9f 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1,6 +1,6 @@
#
-# This file is autogenerated by pip-compile with python 3.10
-# To update, run:
+# This file is autogenerated by pip-compile with Python 3.11
+# by the following command:
#
# pip-compile --resolver=backtracking docs/requirements.in
#
@@ -76,13 +76,13 @@ python-dateutil==2.8.2
# via matplotlib
pyyaml==6.0
# via sphinx-autoapi
-referencing==0.24.2
+referencing==0.24.3
# via
# jsonschema
# jsonschema-specifications
requests==2.28.2
# via sphinx
-rpds-py==0.5.2
+rpds-py==0.6.1
# via
# jsonschema
# referencing
@@ -129,8 +129,6 @@ sphinxcontrib-spelling==8.0.0
# via -r docs/requirements.in
sphinxext-opengraph==0.8.1
# via -r docs/requirements.in
-typing-extensions==4.5.0
- # via astroid
unidecode==1.3.6
# via sphinx-autoapi
urllib3==1.26.14
diff --git a/pyproject.toml b/pyproject.toml
index d821e34..579bc7a 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -32,9 +32,9 @@ dynamic = ["version", "readme"]
dependencies = [
"attrs>=22.2.0",
- "jsonschema-specifications>=2023.03.1",
- "referencing>=0.24.2",
- "rpds-py>=0.5.2",
+ "jsonschema-specifications>=2023.03.3",
+ "referencing>=0.24.3",
+ "rpds-py>=0.6.1",
"importlib_metadata;python_version<'3.8'",
"typing_extensions;python_version<'3.8'",