From: R David Murray Date: Sun, 27 May 2012 21:10:36 +0000 (-0400) Subject: #11785: fix the :mod: references in email package submodule titles. X-Git-Tag: v3.3.0a4~43 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=79cf3bad1b1ba4632e0467f0c4f86504c2fa73df;p=thirdparty%2FPython%2Fcpython.git #11785: fix the :mod: references in email package submodule titles. Also adds the TOC entry for headerregistry. --- diff --git a/Doc/library/email.charset.rst b/Doc/library/email.charset.rst index 1249b71e2e54..a828f3caa95a 100644 --- a/Doc/library/email.charset.rst +++ b/Doc/library/email.charset.rst @@ -1,5 +1,5 @@ -:mod:`email`: Representing character sets ------------------------------------------ +:mod:`email.charset`: Representing character sets +------------------------------------------------- .. module:: email.charset :synopsis: Character Sets diff --git a/Doc/library/email.encoders.rst b/Doc/library/email.encoders.rst index 81d30961db29..916ba5d18a7c 100644 --- a/Doc/library/email.encoders.rst +++ b/Doc/library/email.encoders.rst @@ -1,5 +1,5 @@ -:mod:`email`: Encoders ----------------------- +:mod:`email.encoders`: Encoders +------------------------------- .. module:: email.encoders :synopsis: Encoders for email message payloads. diff --git a/Doc/library/email.errors.rst b/Doc/library/email.errors.rst index e907c51cd285..d8f330f4bec3 100644 --- a/Doc/library/email.errors.rst +++ b/Doc/library/email.errors.rst @@ -1,5 +1,5 @@ -:mod:`email`: Exception and Defect classes ------------------------------------------- +:mod:`email.errors`: Exception and Defect classes +------------------------------------------------- .. module:: email.errors :synopsis: The exception classes used by the email package. diff --git a/Doc/library/email.generator.rst b/Doc/library/email.generator.rst index 73440b82ba81..b8e4e91ff6fb 100644 --- a/Doc/library/email.generator.rst +++ b/Doc/library/email.generator.rst @@ -1,5 +1,5 @@ -:mod:`email`: Generating MIME documents ---------------------------------------- +:mod:`email.generator`: Generating MIME documents +------------------------------------------------- .. module:: email.generator :synopsis: Generate flat text email messages from a message structure. diff --git a/Doc/library/email.header.rst b/Doc/library/email.header.rst index 47a0749d527c..7d2dc2e61ec8 100644 --- a/Doc/library/email.header.rst +++ b/Doc/library/email.header.rst @@ -1,5 +1,5 @@ -:mod:`email`: Internationalized headers ---------------------------------------- +:mod:`email.header`: Internationalized headers +---------------------------------------------- .. module:: email.header :synopsis: Representing non-ASCII headers diff --git a/Doc/library/email.headerregistry.rst b/Doc/library/email.headerregistry.rst index 4fc9594bc3be..97fcf2a57ec8 100644 --- a/Doc/library/email.headerregistry.rst +++ b/Doc/library/email.headerregistry.rst @@ -4,6 +4,10 @@ .. module:: email.headerregistry :synopsis: Automatic Parsing of headers based on the field name +.. moduleauthor:: R. David Murray +.. sectionauthor:: R. David Murray + + .. note:: The headerregistry module has been included in the standard library on a diff --git a/Doc/library/email.iterators.rst b/Doc/library/email.iterators.rst index 6c35b7988a7e..d1f1797e39ff 100644 --- a/Doc/library/email.iterators.rst +++ b/Doc/library/email.iterators.rst @@ -1,5 +1,5 @@ -:mod:`email`: Iterators ------------------------ +:mod:`email.iterators`: Iterators +--------------------------------- .. module:: email.iterators :synopsis: Iterate over a message object tree. diff --git a/Doc/library/email.message.rst b/Doc/library/email.message.rst index 3e632581b742..f685e540d242 100644 --- a/Doc/library/email.message.rst +++ b/Doc/library/email.message.rst @@ -1,5 +1,5 @@ -:mod:`email`: Representing an email message -------------------------------------------- +:mod:`email.message`: Representing an email message +--------------------------------------------------- .. module:: email.message :synopsis: The base class representing email messages. diff --git a/Doc/library/email.mime.rst b/Doc/library/email.mime.rst index f3f34c8dd17a..db5584c905aa 100644 --- a/Doc/library/email.mime.rst +++ b/Doc/library/email.mime.rst @@ -1,5 +1,5 @@ -:mod:`email`: Creating email and MIME objects from scratch ----------------------------------------------------------- +:mod:`email.mime`: Creating email and MIME objects from scratch +--------------------------------------------------------------- .. module:: email.mime :synopsis: Build MIME messages. diff --git a/Doc/library/email.parser.rst b/Doc/library/email.parser.rst index a0303a4b6ec2..96fe44442f67 100644 --- a/Doc/library/email.parser.rst +++ b/Doc/library/email.parser.rst @@ -1,5 +1,5 @@ -:mod:`email`: Parsing email messages ------------------------------------- +:mod:`email.parser`: Parsing email messages +------------------------------------------- .. module:: email.parser :synopsis: Parse flat text email messages to produce a message object structure. diff --git a/Doc/library/email.policy.rst b/Doc/library/email.policy.rst index 2ba0dbaaef71..9ab949eb7884 100644 --- a/Doc/library/email.policy.rst +++ b/Doc/library/email.policy.rst @@ -1,9 +1,12 @@ -:mod:`email`: Policy Objects ----------------------------- +:mod:`email.policy`: Policy Objects +----------------------------------- .. module:: email.policy :synopsis: Controlling the parsing and generating of messages +.. moduleauthor:: R. David Murray +.. sectionauthor:: R. David Murray + .. versionadded:: 3.3 diff --git a/Doc/library/email.rst b/Doc/library/email.rst index fc206f4db289..ef5354fee2c4 100644 --- a/Doc/library/email.rst +++ b/Doc/library/email.rst @@ -52,6 +52,7 @@ Contents of the :mod:`email` package documentation: email.parser.rst email.generator.rst email.policy.rst + email.headerregistry.rst email.mime.rst email.header.rst email.charset.rst diff --git a/Doc/library/email.util.rst b/Doc/library/email.util.rst index 1383104b1b7c..b05c5d215087 100644 --- a/Doc/library/email.util.rst +++ b/Doc/library/email.util.rst @@ -1,5 +1,5 @@ -:mod:`email`: Miscellaneous utilities -------------------------------------- +:mod:`email.utils`: Miscellaneous utilities +------------------------------------------- .. module:: email.utils :synopsis: Miscellaneous email package utilities.