Update to jsonschema > 4.18, Sphinx < 7 #572
Conversation
HGSilveri
force-pushed
the
hs/update-jsonschema
branch
from
dadab5a
to
336b2af
Compare
HGSilveri
changed the title
|
Turns out it was the Sphinx version. It's too complex for me to figure out exactly why, but restricting to <7 solves the issue. |
There was a problem hiding this comment.
I indeed don't think that jsonschema is responsible for our issues, since I made a commit that passed on August 8th whereas their latest change was on August 7th. Yet, it's good to make these changes, but I have a question regarding them: I see the resource taken for the registry is SCHEMAS["device"] whereas we used to take the SCHEMAS["sequence"] as referring document in the `RefResolver. Why this difference ? Why is it working ?
| base_uri=f"{SCHEMAS_PATH.resolve().as_uri()}/", | ||
| referrer=SCHEMAS["sequence"], | ||
| REGISTRY: Registry = Registry().with_resources( | ||
| [("device-schema.json", Resource.from_contents(SCHEMAS["device"]))] |
There was a problem hiding this comment.
Why is it device and not sequence ?
There was a problem hiding this comment.
Tbh, I think I never quite understood what the referrer argument did (in their docs, they have an example where they set it to True 🙃), I just went with something that worked. The schema being referred and the name (ie device-schema.json) was taken from the path in the base_uri.
Now, what we are doing is specifically building a Registry with the schemas that can be referred and the name they are referred by.
There was a problem hiding this comment.
Okay I just had a quick look at the doc but did not go further, I understood the role of the Registry and the Resource so let's go with this ;)
| base_uri=f"{SCHEMAS_PATH.resolve().as_uri()}/", | ||
| referrer=SCHEMAS["sequence"], | ||
| REGISTRY: Registry = Registry().with_resources( | ||
| [("device-schema.json", Resource.from_contents(SCHEMAS["device"]))] |
There was a problem hiding this comment.
Okay I just had a quick look at the doc but did not go further, I understood the role of the Registry and the Resource so let's go with this ;)
I suspect this is what's causing problems in the docs build, so I'm switching to the reference system introduced in
jsonschema 4.18.