traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

#11785: fix the :mod: references in email package submodule titles. 

Also adds the TOC entry for headerregistry.
This commit is contained in:
R David Murray 2012-05-27 17:10:36 -04:00
parent ea9766897b
commit 79cf3bad1b
13 changed files with 30 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Doc/library/email.charset.rst
View File

@ -1,5 +1,5 @@
:mod:`email`: Representing character sets :mod:`email.charset`: Representing character sets
----------------------------------------- -------------------------------------------------
.. module:: email.charset .. module:: email.charset
:synopsis: Character Sets :synopsis: Character Sets

4
Doc/library/email.encoders.rst
View File

@ -1,5 +1,5 @@
:mod:`email`: Encoders :mod:`email.encoders`: Encoders
---------------------- -------------------------------
.. module:: email.encoders .. module:: email.encoders
:synopsis: Encoders for email message payloads. :synopsis: Encoders for email message payloads.

4
Doc/library/email.errors.rst
View File

@ -1,5 +1,5 @@
:mod:`email`: Exception and Defect classes :mod:`email.errors`: Exception and Defect classes
------------------------------------------ -------------------------------------------------
.. module:: email.errors .. module:: email.errors
:synopsis: The exception classes used by the email package. :synopsis: The exception classes used by the email package.

4
Doc/library/email.generator.rst
View File

@ -1,5 +1,5 @@
:mod:`email`: Generating MIME documents :mod:`email.generator`: Generating MIME documents
--------------------------------------- -------------------------------------------------
.. module:: email.generator .. module:: email.generator
:synopsis: Generate flat text email messages from a message structure. :synopsis: Generate flat text email messages from a message structure.

4
Doc/library/email.header.rst
View File

@ -1,5 +1,5 @@
:mod:`email`: Internationalized headers :mod:`email.header`: Internationalized headers
--------------------------------------- ----------------------------------------------
.. module:: email.header .. module:: email.header
:synopsis: Representing non-ASCII headers :synopsis: Representing non-ASCII headers

4
Doc/library/email.headerregistry.rst
View File

@ -4,6 +4,10 @@
.. module:: email.headerregistry .. module:: email.headerregistry
:synopsis: Automatic Parsing of headers based on the field name :synopsis: Automatic Parsing of headers based on the field name
.. moduleauthor:: R. David Murray <rdmurray@bitdance.com>
.. sectionauthor:: R. David Murray <rdmurray@bitdance.com>
.. note:: .. note::
The headerregistry module has been included in the standard library on a The headerregistry module has been included in the standard library on a

4
Doc/library/email.iterators.rst
View File

@ -1,5 +1,5 @@
:mod:`email`: Iterators :mod:`email.iterators`: Iterators
----------------------- ---------------------------------
.. module:: email.iterators .. module:: email.iterators
:synopsis: Iterate over a message object tree. :synopsis: Iterate over a message object tree.

4
Doc/library/email.message.rst
View File

@ -1,5 +1,5 @@
:mod:`email`: Representing an email message :mod:`email.message`: Representing an email message
------------------------------------------- ---------------------------------------------------
.. module:: email.message .. module:: email.message
:synopsis: The base class representing email messages. :synopsis: The base class representing email messages.

4
Doc/library/email.mime.rst
View File

@ -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 .. module:: email.mime
:synopsis: Build MIME messages. :synopsis: Build MIME messages.

4
Doc/library/email.parser.rst
View File

@ -1,5 +1,5 @@
:mod:`email`: Parsing email messages :mod:`email.parser`: Parsing email messages
------------------------------------ -------------------------------------------
.. module:: email.parser .. module:: email.parser
:synopsis: Parse flat text email messages to produce a message object structure. :synopsis: Parse flat text email messages to produce a message object structure.

7
Doc/library/email.policy.rst
View File

@ -1,9 +1,12 @@
:mod:`email`: Policy Objects :mod:`email.policy`: Policy Objects
---------------------------- -----------------------------------
.. module:: email.policy .. module:: email.policy
:synopsis: Controlling the parsing and generating of messages :synopsis: Controlling the parsing and generating of messages
.. moduleauthor:: R. David Murray <rdmurray@bitdance.com>
.. sectionauthor:: R. David Murray <rdmurray@bitdance.com>
.. versionadded:: 3.3 .. versionadded:: 3.3

1
Doc/library/email.rst
View File

@ -52,6 +52,7 @@ Contents of the :mod:`email` package documentation:
email.parser.rst email.parser.rst
email.generator.rst email.generator.rst
email.policy.rst email.policy.rst
email.headerregistry.rst
email.mime.rst email.mime.rst
email.header.rst email.header.rst
email.charset.rst email.charset.rst

4
Doc/library/email.util.rst
View File

@ -1,5 +1,5 @@
:mod:`email`: Miscellaneous utilities :mod:`email.utils`: Miscellaneous utilities
------------------------------------- -------------------------------------------
.. module:: email.utils .. module:: email.utils
:synopsis: Miscellaneous email package utilities. :synopsis: Miscellaneous email package utilities.