docutils.transforms.peps Namespace Reference

Classes
class	Contents
class	Headers
class	PEPZero
class	PEPZeroSpecial
class	TargetNotes

Functions
	mask_email (ref, pepno=None)

Variables
tuple	non_masked_addresses

Detailed Description

Transforms for PEP processing.

- `Headers`: Used to transform a PEP's initial RFC-2822 header.  It remains a
  field list, but some entries get processed.
- `Contents`: Auto-inserts a table of contents.
- `PEPZero`: Special processing for PEP 0.

Function Documentation

mask_email()

docutils.transforms.peps.mask_email	(		ref,
			pepno = None
	)

Mask the email address in `ref` and return a replacement node.

`ref` is returned unchanged if it contains no email address.

For email addresses such as "user@host", mask the address as "user at
host" (text) to thwart simple email address harvesters (except for those
listed in `non_masked_addresses`).  If a PEP number (`pepno`) is given,
return a reference including a default email subject.

Variable Documentation

non_masked_addresses

tuple docutils.transforms.peps.non_masked_addresses

Initial value:

=  ('peps@python.org',
                        'python-list@python.org',
                        'python-dev@python.org')