sondra.help module¶
- class sondra.help.RSTBuilder(fmt='rst', out=None, initial_heading_level=0)[source]¶
Bases: builtins.object
A simple builder for reStructuredText help.
Does not support all of RST by a long shot. However, it provides sufficient functionality to be useful for generating help from JSON.
- HEADING_CHARS = "#=*+-~^`_:.'"¶
- class sondra.help.SchemaHelpBuilder(schema, url='', fmt='rst', out=None, initial_heading_level=0)[source]¶
Bases: sondra.help.RSTBuilder
Builds help from a JSON-Schema as either HTML or reStructuredText source.
- RESERVED_WORDS = {'dependencies', 'patternProperties', 'minProperties', 'id', 'additionalProperties', 'title', 'properties', 'name', 'description', 'required', 'type', 'maxProperties'}¶