This Sphinx extension allows authors to embed a JSON Schema in their documentation.
It arose out of a personal itch and implements what I needed. Some features of JSON Schema are (not yet) implemented. Also I can imagine that other display layouts are desired.
I only tested it for use with the draft 4 specification of JSON Schema. I was pleasantly surprised to find that the software is useful to others as well. Therefore it made sense to document its intended use.
Glenn Nicholls <https://github.com/GlenNicholls> contributed code to load a schema from a
Python dict or object (or actually any Python entity with a
Expanding on the work of Pavel Odvody with JSON Pointer
:pass_unmodified: option is included.
This option prevents escaping the string pointed at.
This extension arose from discussions with Ryan Lane <https://github.com/ryan-lane>
Pavel Odvody contributed the
:hide_key: directive option.
This option allows you to hide certain keys, specified by a JSON Pointer specification, to be excluded
Removed debugging code left in, pointed out by Kevin Landreth <https://github.com/CrackerJackMack>.
iamdbychkov added the
:encoding: directive option.
This option allows explicit control of the encoding used to read a file instead of
relying on the operating system default.
:lift_title: directive option suggested by ankostis.
Ankostis also provided an example on how to extend the formatter to handle custom properties.
Fixed a bug in rendering the
items attribute of the
array type reported by nijel.
Fixed bugs rendering the
Introduced the configuration entry
jsonschema_options setting default values for the directive options
introduced in 1.16. The options now can accept a parameter to explicitly turn the option on or off.
WouterTuinstra reimplemented support for
dependencies and properly this time.
He also improved error handling and reporting and added a couple of options improving the handling of references.
The most important additions are the directive options
In addition to all that he also implemented support for the
Add support for the
Versions 1.12, 1.13 and 1.14¶
Solved several minor bugs.
Ivan Vysotskyy contributed the idea to use an array with
description key resulting in the new
Add unicode support.
Implemented schema cross referencing.
Initial release of a functioning plugin.