Package epydoc :: Package markup :: Module restructuredtext :: Class _EpydocReader

[hide private]
[frames] | no frames]

# Class _EpydocReader

source code

A reader that captures all errors that are generated by parsing, and appends them to a list.

Instance Methods | [hide private]

get_transforms(self) Transforms required by this class. | source code call graph

Call Graph

__init__(self, errors) Initialize the Reader instance. | source code call graph

Call Graph

new_document(self) Create and return a new empty document tree (root node). | source code call graph

Call Graph

report(self, error) | source code

Inherited from `docwriter.xlink.ApiLinkReader`: `read` Inherited from `docutils.readers.Reader`: `parse`, `set_parser` Inherited from `docutils.Component`: `supports`

Class Methods | [hide private]

Inherited from `docwriter.xlink.ApiLinkReader`: `read_configuration`

Class Variables | [hide private]

| default_transforms = `list(ApiLinkReader.default_transforms)`
| v = ``'``5``'``

Inherited from `docwriter.xlink.ApiLinkReader`: `settings_spec`

Inherited from `docwriter.xlink.ApiLinkReader` (private): `_conf`

Inherited from `docutils.readers.standalone.Reader`: `config_section`, `config_section_dependencies`, `document`, `supported`

Inherited from `docutils.readers.Reader`: `component_type`

Inherited from `docutils.SettingsSpec`: `relative_path_settings`, `settings_default_overrides`, `settings_defaults`

Inherited from `docutils.TransformSpec`: `unknown_reference_resolvers`

Method Details | [hide private]

### get_transforms(self)

source code
call graph

Call Graph

Transforms required by this class. Override in subclasses.

Overrides: docutils.TransformSpec.get_transforms
  (inherited documentation)

### __init__(self, errors)
(Constructor)

source code
call graph

Call Graph

Initialize the Reader instance.

Several instance attributes are defined with dummy initial values. Subclasses may use these attributes as they wish.

Overrides: docutils.readers.Reader.__init__
  (inherited documentation)

### new_document(self)

source code
call graph

Call Graph

Create and return a new empty document tree (root node).

Overrides: docutils.readers.Reader.new_document
  (inherited documentation)