docutils.readers.standalone module

Standalone file Reader for the reStructuredText markup syntax.

class Reader(parser=None, parser_name=None)[source]

Bases: Reader

supported = ('standalone',)

Contexts this reader supports.

document = None

A single document tree.

settings_spec = ('Standalone Reader Options', None, (('Disable the promotion of a lone top-level section title to document title (and subsequent section title to document subtitle promotion; enabled by default).', ['--no-doc-title'], {'action': 'store_false', 'default': 1, 'dest': 'doctitle_xform', 'validator': <function validate_boolean>}), ('Disable the bibliographic field list transform (enabled by default).', ['--no-doc-info'], {'action': 'store_false', 'default': 1, 'dest': 'docinfo_xform', 'validator': <function validate_boolean>}), ('Activate the promotion of lone subsection titles to section subtitles (disabled by default).', ['--section-subtitles'], {'action': 'store_true', 'default': 0, 'dest': 'sectsubtitle_xform', 'validator': <function validate_boolean>}), ('Deactivate the promotion of lone subsection titles.', ['--no-section-subtitles'], {'action': 'store_false', 'dest': 'sectsubtitle_xform'})))

Runtime settings specification. Override in subclasses.

Defines runtime settings and associated command-line options, as used by docutils.frontend.OptionParser. This is a tuple of:

  • Option group title (string or None which implies no group, just a list of single options).

  • Description (string or None).

  • A sequence of option tuples. Each consists of:

    • Help text (string)

    • List of option strings (e.g. ['-Q', '--quux']).

    • Dictionary of keyword arguments sent to the OptionParser/OptionGroup add_option method.

      Runtime setting names are derived implicitly from long option names (’–a-setting’ becomes settings.a_setting) or explicitly from the ‘dest’ keyword argument.

      Most settings will also have a ‘validator’ keyword & function. The validator function validates setting values (from configuration files and command-line option arguments) and converts them to appropriate types. For example, the docutils.frontend.validate_boolean function, required by all boolean settings, converts true values (‘1’, ‘on’, ‘yes’, and ‘true’) to 1 and false values (‘0’, ‘off’, ‘no’, ‘false’, and ‘’) to 0. Validators need only be set once per setting. See the docutils.frontend.validate_* functions.

      See the optparse docs for more details.

  • More triples of group title, description, options, as many times as needed. Thus, settings_spec tuples can be simply concatenated.

config_section = 'standalone reader'

The name of the config file section specific to this component (lowercase, no brackets). Override in subclasses.

config_section_dependencies = ('readers',)

A list of names of config file sections that are to be applied before config_section, in order (from general to specific). In other words, the settings in config_section are to be overlaid on top of the settings from these sections. The “general” section is assumed implicitly. Override in subclasses.

get_transforms()[source]

Transforms required by this class. Override in subclasses.