summaryrefslogtreecommitdiff
path: root/docutils/readers/pep.py
diff options
context:
space:
mode:
Diffstat (limited to 'docutils/readers/pep.py')
-rw-r--r--docutils/readers/pep.py50
1 files changed, 50 insertions, 0 deletions
diff --git a/docutils/readers/pep.py b/docutils/readers/pep.py
new file mode 100644
index 000000000..b181e20c8
--- /dev/null
+++ b/docutils/readers/pep.py
@@ -0,0 +1,50 @@
+# Author: David Goodger
+# Contact: goodger@users.sourceforge.net
+# Revision: $Revision$
+# Date: $Date$
+# Copyright: This module has been placed in the public domain.
+
+"""
+Python Enhancement Proposal (PEP) Reader.
+"""
+
+__docformat__ = 'reStructuredText'
+
+
+from docutils.readers import standalone
+from docutils.transforms import peps, references, misc, frontmatter
+from docutils.parsers import rst
+
+
+class Reader(standalone.Reader):
+
+ supported = ('pep',)
+ """Contexts this reader supports."""
+
+ settings_spec = (
+ 'PEP Reader Option Defaults',
+ 'The --pep-references and --rfc-references options (for the '
+ 'reStructuredText parser) are on by default.',
+ ())
+
+ config_section = 'pep reader'
+ config_section_dependencies = ('readers', 'standalone reader')
+
+ def get_transforms(self):
+ transforms = standalone.Reader.get_transforms(self)
+ # We have PEP-specific frontmatter handling.
+ transforms.remove(frontmatter.DocTitle)
+ transforms.remove(frontmatter.SectionSubTitle)
+ transforms.remove(frontmatter.DocInfo)
+ transforms.extend([peps.Headers, peps.Contents, peps.TargetNotes])
+ return transforms
+
+ settings_default_overrides = {'pep_references': 1, 'rfc_references': 1}
+
+ inliner_class = rst.states.Inliner
+
+ def __init__(self, parser=None, parser_name=None):
+ """`parser` should be ``None``."""
+ if parser is None:
+ parser = rst.Parser(rfc2822=1, inliner=self.inliner_class())
+ standalone.Reader.__init__(self, parser, '')