Introduction

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.

It was written for the draft 4 specification of JSON Schema and renders the keywords of the later drafts up to 2020-12 as well, see Supported JSON Schema versions. I was pleasantly surprised to find that the software is useful to others as well. Therefore it made sense to document its intended use.

Contents

• Installation
  • Source code
• Directive
  • Usage
  • Options
• Supported JSON Schema versions
  • Supported keywords
  • Known limitations
• Schema extensions
  • $$description
  • $$target
• Organization
• Extending jsonschema
  • Render custom keywords
• Changelog
  • Version 1.20.1
  • Version 1.20.0
  • Version 1.19.2
  • Version 1.19.1
  • Version 1.19.0
  • Version 1.18.0
  • Version 1.17.2
  • Version 1.17.0
  • Version 1.16.11
  • Version 1.16.10
  • Version 1.16.9
  • Version 1.16.8
  • Version 1.16.5-6
  • Version 1.16.4
  • Version 1.16.1-3
  • Version 1.16
  • Version 1.15
  • Versions 1.12 and 1.13 and 1.14
  • Version 1.11
  • Version 1.10
  • Version 1.9
  • Version 1.4
  • Version 1.3
  • Version 1.2
  • Version 1.1
  • Version 1.0

Indices and tables

• Index

• Module Index

• Search Page