docutils.transforms.peps

Package docutils :: Package transforms :: Module peps

[show private | hide private]

Module docutils.transforms.peps

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.

Classes
`Contents`	Insert a table of contents transform placeholder into the document after the RFC 2822 header.
`Headers`	Process fields in a PEP's initial RFC-2822 header.
`PEPZero`	Special processing for PEP 0.
`PEPZeroSpecial`	Perform the special processing needed by PEP 0:
`TargetNotes`	Locate the "References" section, insert a placeholder for an external target footnote insertion transform at the end, and schedule the transform to run immediately.

Function Summary
	`mask_email(ref, pepno)` Mask the email address in `ref` and return a replacement node.

Variable Summary
`tuple`	`non_masked_addresses` = `('peps@python.org', 'python-list@...`

Function Details

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 Details

non_masked_addresses

Type:: tuple
Value:: ('peps@python.org', 'python-list@python.org', 'python-dev@python.org')

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

http://epydoc.sf.net