sphinx-jsonschema
sphinx-jsonschema copied to clipboard
lnoor
A Sphinx extension to display a JSON Schema
I was trying to include a schema (written in YAML) in my documentation (built with Sphinx), but it did not work unless there was something under the ```jsonschema``` directive. For...
I have the below schema defined in a python file where I am trying to use reST in the description of a property. ``` python import inspect schema_debug: dict =...
After the 1.19.0 release, I attempted to document my python object. Anyways, my schema looks sort of like this: ``` python schema: dict = { "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "schema", "type":...
Sorry for the neophyte question, but I have a somewhat complex JSON schema structure where a top-level schema includes several other schemas, which in turn define new objects in their...
When trying to run the tests, they all fail. Am I missing something? ``` PYTHONPATH=/home/abuild/rpmbuild/BUILDROOT/python-sphinx-jsonschema-1.16.7-0.x86_64/usr/lib/python3.6/site-packages PYTHONDONTWRITEBYTECODE=1 pytest-3.6 --ignore=_build.python36 --ignore=_build.python38 -v --trace -rs ============================= test session starts ============================== platform linux --...
instead of tag use something like or mark parent tag with CSS class to make it possibe to change text color/use background images or highlight them in other ways.
Hello and thanks for this cool extension :) How difficult would it be to add a parameter to choose how deep we want to read the schema? Typically: ``` .....
I have several default values that include `>` in them, like `>=3.15`. The `>` dissapears in the rendering. I tried `:pass_unmodified:` but it didn't seem to help. Can be seen...
The example was broken because the indentation wasn't correct. I fixed it.
I'm getting a lot of `WARNING: undefined label` when loading this [schema.json](https://github.com/user-attachments/files/19123583/schema.json). For example, last warning is `WARNING: undefined label: '#/$defs/choiceparams'`, and indeed, I only have `#/$defs/ChoiceParams` which has different...
