API Reference

Sphinx extension for literalizer.

Provides the literalizer directive, which reads a data file and renders it as a native language literal block.

class sphinx_literalizer.LiteralizerDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Directive that converts a data file to a native literal block.

Usage:

.. literalizer:: path/to/data.json
   :language: python
   :input-format: json
   :pre-indent-level: 2
   :indent: 4
   :indent-char: spaces
   :include-delimiters:
   :date-format: python
   :datetime-format: python
   :variable-name: my_var
   :existing-variable:
   :sequence-format: list
   :set-format: frozenset
   :bytes-format: python
   :comment-format: block
   :variable-type-hints: always
   :declaration-style: const
   :dict-entry-style: rocket
   :dict-format: object
   :float-format: repr
   :integer-format: decimal
   :numeric-literal-suffix: none
   :numeric-separator: none
   :string-format: double
   :trailing-comma: yes
   :line-ending: semicolon
   :empty-dict-key: positional
   :default-set-element-type: String
   :default-sequence-element-type: String
   :default-dict-key-type: String
   :default-dict-value-type: String
   :default-ordered-map-value-type: any

has_content = False

May the directive have content?

option_spec: ClassVar[dict[str, Callable[[str], Any]] | None] = {'bytes-format': <function _make_format_validator.<locals>.validator>, 'comment-format': <function _make_format_validator.<locals>.validator>, 'date-format': <function _make_format_validator.<locals>.validator>, 'datetime-format': <function _make_format_validator.<locals>.validator>, 'declaration-style': <function _make_format_validator.<locals>.validator>, 'default-dict-key-type': <function unchanged>, 'default-dict-value-type': <function unchanged>, 'default-ordered-map-value-type': <function unchanged>, 'default-sequence-element-type': <function unchanged>, 'default-set-element-type': <function unchanged>, 'dict-entry-style': <function _make_format_validator.<locals>.validator>, 'dict-format': <function _make_format_validator.<locals>.validator>, 'empty-dict-key': <function _make_format_validator.<locals>.validator>, 'existing-variable': <function flag>, 'float-format': <function _make_format_validator.<locals>.validator>, 'include-delimiters': <function flag>, 'indent': <function nonnegative_int>, 'indent-char': <function LiteralizerDirective.<lambda>>, 'input-format': <function LiteralizerDirective.<lambda>>, 'integer-format': <function _make_format_validator.<locals>.validator>, 'language': <function LiteralizerDirective.<lambda>>, 'line-ending': <function _make_format_validator.<locals>.validator>, 'numeric-literal-suffix': <function _make_format_validator.<locals>.validator>, 'numeric-separator': <function _make_format_validator.<locals>.validator>, 'pre-indent-level': <function nonnegative_int>, 'sequence-format': <function _make_format_validator.<locals>.validator>, 'set-format': <function _make_format_validator.<locals>.validator>, 'string-format': <function _make_format_validator.<locals>.validator>, 'trailing-comma': <function _make_format_validator.<locals>.validator>, 'variable-name': <function unchanged>, 'variable-type-hints': <function _make_format_validator.<locals>.validator>}

Mapping of option names to validator functions.

required_arguments = 1

Number of required directive arguments.

run() → list[Node]

Read the data file and produce a literal block.

sphinx_literalizer.setup(app: Sphinx) → ExtensionMetadata

Register the extension with Sphinx.