Skip to content

Commit ca96760

Browse files
committed
Make the link to Understanding JSON Schema more prominent.
(And remove some ancient language from when it was a twinkle in someone's eye).
1 parent 57b604e commit ca96760

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@
8989

9090
intersphinx_mapping = {
9191
"python": ("https://docs.python.org/3", None),
92+
"ujs": ("https://json-schema.org/understanding-json-schema/", None),
9293
}
9394

9495

docs/validate.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ Schema Validation
55

66
.. currentmodule:: jsonschema
77

8+
.. tip::
9+
10+
Most of the documentation for this package assumes you're familiar with the fundamentals of writing JSON schemas themselves, and focuses on how this library helps you validate with them in Python.
11+
12+
If you aren't already comfortable with writing schemas and need an introduction which teaches about JSON Schema the specification, you may find `Understanding JSON Schema <ujs:basics>` to be a good read!
13+
814

915
The Basics
1016
----------
@@ -15,11 +21,6 @@ The simplest way to validate an instance under a given schema is to use the
1521
.. autofunction:: validate
1622
:noindex:
1723

18-
.. [#] For information on creating JSON schemas to validate
19-
your data, there is a good introduction to JSON Schema
20-
fundamentals underway at `Understanding JSON Schema
21-
<https://json-schema.org/understanding-json-schema/>`_
22-
2324
.. _validator-protocol:
2425

2526
The Validator Protocol

0 commit comments

Comments
 (0)