summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2012-05-27 21:10:36 (GMT)
committerR David Murray <rdmurray@bitdance.com>2012-05-27 21:10:36 (GMT)
commit79cf3bad1b1ba4632e0467f0c4f86504c2fa73df (patch)
tree78f8ef938b1d95e1c4130652cf821402f237aa0d
parentea9766897bf1d2ccf610ff9ce805acca7c4cce6f (diff)
downloadcpython-79cf3bad1b1ba4632e0467f0c4f86504c2fa73df.zip
cpython-79cf3bad1b1ba4632e0467f0c4f86504c2fa73df.tar.gz
cpython-79cf3bad1b1ba4632e0467f0c4f86504c2fa73df.tar.bz2
#11785: fix the :mod: references in email package submodule titles.
Also adds the TOC entry for headerregistry.
-rw-r--r--Doc/library/email.charset.rst4
-rw-r--r--Doc/library/email.encoders.rst4
-rw-r--r--Doc/library/email.errors.rst4
-rw-r--r--Doc/library/email.generator.rst4
-rw-r--r--Doc/library/email.header.rst4
-rw-r--r--Doc/library/email.headerregistry.rst4
-rw-r--r--Doc/library/email.iterators.rst4
-rw-r--r--Doc/library/email.message.rst4
-rw-r--r--Doc/library/email.mime.rst4
-rw-r--r--Doc/library/email.parser.rst4
-rw-r--r--Doc/library/email.policy.rst7
-rw-r--r--Doc/library/email.rst1
-rw-r--r--Doc/library/email.util.rst4
13 files changed, 30 insertions, 22 deletions
diff --git a/Doc/library/email.charset.rst b/Doc/library/email.charset.rst
index 1249b71..a828f3c 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 81d3096..916ba5d 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 e907c51..d8f330f 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 73440b8..b8e4e91 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 47a0749..7d2dc2e 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 4fc9594..97fcf2a 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 <rdmurray@bitdance.com>
+.. sectionauthor:: R. David Murray <rdmurray@bitdance.com>
+
+
.. 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 6c35b79..d1f1797 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 3e63258..f685e54 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 f3f34c8..db5584c 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 a0303a4..96fe444 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 2ba0dba..9ab949e 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 <rdmurray@bitdance.com>
+.. sectionauthor:: R. David Murray <rdmurray@bitdance.com>
+
.. versionadded:: 3.3
diff --git a/Doc/library/email.rst b/Doc/library/email.rst
index fc206f4..ef5354f 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 1383104..b05c5d2 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.