docutils.parsers.rst.Parser

Package docutils :: Package parsers :: Package rst :: Class Parser

[show private | hide private]

Class Parser

 SettingsSpec --+        
                |        
TransformSpec --+        
                |        
        Component --+    
                    |    
               Parser --+
                        |
                       Parser

The reStructuredText parser.

Method Summary
	`__init__(self, rfc2822, inliner)`
	`parse(self, inputstring, document)` Parse `inputstring` and populate `document`, a document tree.
Inherited from Parser
	`finish_parse(self)` Finalize parse details.
	`setup_parse(self, inputstring, document)` Initial parse setup.
Inherited from Component
	`supports(self, format)` Is `format` supported by this component?

Class Variable Summary
`tuple`	`settings_spec` = `('reStructuredText Parser Options', None...`
`tuple`	`supported` = `('restructuredtext', 'rst', 'rest', 'restx',...`
Inherited from Parser
`str`	`component_type` = `'parser'`
Inherited from SettingsSpec
`tuple`	`relative_path_settings` = `()`
`NoneType`	`settings_default_overrides` = None
`NoneType`	`settings_defaults` = None
Inherited from TransformSpec
`tuple`	`default_transforms` = `()`

Method Details

parse(self, inputstring, document)

Parse inputstring and populate document, a document tree.

Overrides:: docutils.parsers.Parser.parse

Class Variable Details

settings_spec

Type:: tuple
Value:: ('reStructuredText Parser Options', None, (('Recognize and link to PEP references (like "PEP 258").', ['--pep-references'], {'action': 'store_true'}), ('Recognize and link to RFC references (like "RFC 822").', ['--rfc-references'], {'action': 'store_true'}), ...

supported

Type:: tuple
Value:: ('restructuredtext', 'rst', 'rest', 'restx', 'rtxt', 'rstx')

Generated by Epydoc 2.0 on Tue Jul 22 05:31:13 2003

http://epydoc.sf.net