Extension Demo

This page keeps a few visual examples of the Sphinx directive in action. For configuration and integration details, see Sphinx Extension.

Shared Default Schema

The directive can use the shared default schema configured in conf.py:

Shared schema from ``schemas/default.json``

Schema From File

The directive can also load JSON from a file relative to the current document:

Pattern objects, arrays, and nested refs from a docs-local file

Inline Schema

Inline JSON is handy for focused examples in API docs:

Inline tuple and combinator example

Theme Override

The directive can also override the global docs theme choice for a single viewer instance:

Mono theme override for a tiny inline schema