class Parser(parsers.Parser): (source)
A do-nothing parser.
Method | parse |
Override to parse `inputstring` into document tree `document`. |
Class Variable | config |
The name of the config file section specific to this component (lowercase, no brackets). Override in subclasses. |
Class Variable | config |
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... |
Class Variable | supported |
Name and aliases for this component. Override in subclasses. |
Inherited from Parser
:
Method | finish |
Finalize parse details. Call at end of `self.parse()`. |
Method | setup |
Initial parse setup. Call at start of `self.parse()`. |
Class Variable | component |
Name of the component type ('reader', 'parser', 'writer'). Override in subclasses. |
Class Variable | settings |
Runtime settings specification. Override in subclasses. |
Instance Variable | document |
Undocumented |
Instance Variable | inputstring |
Undocumented |
Inherited from Component
(via Parser
):
Method | supports |
Is `format` supported by this component? |
Inherited from SettingsSpec
(via Parser
, Component
):
Class Variable | relative |
Settings containing filesystem paths. Override in subclasses. Settings listed here are to be interpreted relative to the current working directory. |
Class Variable | settings |
A dictionary of auxiliary defaults, to override defaults for settings defined in other components' `setting_specs`. Override in subclasses. |
Class Variable | settings |
A dictionary of defaults for settings not in `settings_spec` (internal settings, intended to be inaccessible by command-line and config file). Override in subclasses. |
Inherited from TransformSpec
(via Parser
, Component
):
Method | get |
Transforms required by this class. Override in subclasses. |
Class Variable | default |
Undocumented |
Class Variable | unknown |
List of functions to try to resolve unknown references. Unknown references have a 'refname' attribute which doesn't correspond to any target in the document. Called when the transforms in `docutils.transforms... |
docutils.parsers.Parser.parse
Override to parse `inputstring` into document tree `document`.
docutils.parsers.Parser.config_section
The name of the config file section specific to this component (lowercase, no brackets). Override in subclasses.
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.