docutils.transforms.peps

module documentation
(source)

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.
Class Contents Insert an empty table of contents topic and a transform placeholder into the document after the RFC 2822 header.
Class Headers Process fields in a PEP's initial RFC-2822 header.
Class PEPZero Special processing for PEP 0.
Class PEPZeroSpecial Perform the special processing needed by PEP 0:
Class 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 mask_email Mask the email address in ref and return a replacement node.
Variable non_masked_addresses Undocumented
def mask_email(ref, pepno=None): (source)

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.

non_masked_addresses: tuple[str, ...] = (source)

Undocumented