docutils.__main__.CliSettingsSpec Class Reference

Inheritance diagram for docutils.__main__.CliSettingsSpec:

Collaboration diagram for docutils.__main__.CliSettingsSpec:

Static Public Attributes
tuple	settings_spec
str	config_section = 'docutils application'
tuple	config_section_dependencies
Static Public Attributes inherited from docutils.SettingsSpec
tuple	settings_spec = ()
	settings_defaults = None
	settings_default_overrides = None
tuple	relative_path_settings = ()
	config_section = None
	config_section_dependencies = None

Detailed Description

Runtime settings & command-line options for the generic CLI.

Configurable reader, parser, and writer components.

The "--writer" default will change to 'html' in Docutils 2.0
when 'html' becomes an alias for the current value 'html5'.

Member Data Documentation

config_section_dependencies

tuple docutils.__main__.CliSettingsSpec.config_section_dependencies

static

Initial value:

=  ('docutils-cli application',  # back-compat
                                   'applications')

settings_spec

tuple docutils.__main__.CliSettingsSpec.settings_spec

static

Initial value:

=  (
        'Docutils Application Options',
        'Reader, writer, and parser settings influence the available options. '
        '  Example: use `--help --writer=latex` to see LaTeX writer options. ',
        # options: ('help text', [<option strings>], {<keyword arguments>})
        (('Reader name (currently: "%default").',
          ['--reader'], {'default': 'standalone', 'metavar': '<reader>'}),
         ('Parser name (currently: "%default").',
          ['--parser'], {'default': 'rst', 'metavar': '<parser>'}),
         ('Writer name (currently: "%default").',
          ['--writer'], {'default': 'html5', 'metavar': '<writer>'}),
         )
    )

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/docutils/__main__.py