docutils.readers.standalone.Reader Class Reference

Inheritance diagram for docutils.readers.standalone.Reader:

Collaboration diagram for docutils.readers.standalone.Reader:

Public Member Functions
	get_transforms (self)
Public Member Functions inherited from docutils.readers.Reader
	__init__ (self, parser=None, parser_name=None)
	set_parser (self, parser_name)
	read (self, source, parser, settings)
	parse (self)
	new_document (self)
Public Member Functions inherited from docutils.Component
	supports (self, format)

Static Public Attributes
tuple	supported = ('standalone',)
	document = None
tuple	settings_spec
str	config_section = 'standalone reader'
tuple	config_section_dependencies = ('readers',)
Static Public Attributes inherited from docutils.readers.Reader
str	component_type = 'reader'
str	config_section = 'readers'
Static Public Attributes inherited from docutils.Component
	component_type = None
tuple	supported = ()
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
Static Public Attributes inherited from docutils.TransformSpec
tuple	default_transforms = ()
tuple	unknown_reference_resolvers = ()

Additional Inherited Members
Public Attributes inherited from docutils.readers.Reader
	parser
	source
	input
	settings
	document
Public Attributes inherited from docutils.TransformSpec
	default_transforms

Member Function Documentation

get_transforms()

docutils.readers.standalone.Reader.get_transforms

(

self

)

Transforms required by this class.  Override in subclasses.

Reimplemented from docutils.readers.Reader.

Reimplemented in docutils.readers.pep.Reader.

Member Data Documentation

settings_spec

tuple docutils.readers.standalone.Reader.settings_spec

static

Initial value:

=  (
        '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'],
          {'dest': 'doctitle_xform', 'action': 'store_false',
           'default': True, 'validator': frontend.validate_boolean}),
         ('Disable the bibliographic field list transform (enabled by '
          'default).',
          ['--no-doc-info'],
          {'dest': 'docinfo_xform', 'action': 'store_false',
           'default': True, 'validator': frontend.validate_boolean}),
         ('Activate the promotion of lone subsection titles to '
          'section subtitles (disabled by default).',
          ['--section-subtitles'],
          {'dest': 'sectsubtitle_xform', 'action': 'store_true',
           'default': False, 'validator': frontend.validate_boolean}),
         ('Deactivate the promotion of lone subsection titles.',
          ['--no-section-subtitles'],
          {'dest': 'sectsubtitle_xform', 'action': 'store_false'}),
         ))

---

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

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