Anonymous avatar Anonymous committed fcf007e

Add the email package toctree.

Comments (0)

Files changed (25)

 * adjust all literal include paths
 * remove all non-literal includes
 * fix all duplicate labels and undefined label references
-* fix the email package docs: add a toctree
 * split very large files and add toctrees
 * integrate standalone HOWTOs
 * find out which files get "comments disabled" metadata

Doc-26/library/email-examples.rst

+:mod:`email`: Examples
+----------------------
+
+Here are a few examples of how to use the :mod:`email` package to read, write,
+and send simple email messages, as well as more complex MIME messages.
+
+First, let's see how to create and send a simple text message:
+
+
+.. include:: ../includes/email-simple.py
+   :literal:
+
+Here's an example of how to send a MIME message containing a bunch of family
+pictures that may be residing in a directory:
+
+
+.. include:: ../includes/email-mime.py
+   :literal:
+
+Here's an example of how to send the entire contents of a directory as an email
+message:  [#]_
+
+
+.. include:: ../includes/email-dir.py
+   :literal:
+
+And finally, here's an example of how to unpack a MIME message like the one
+above, into a directory of files:
+
+
+.. include:: ../includes/email-unpack.py
+   :literal:
+
+
+.. rubric:: Footnotes
+
+.. [#] Thanks to Matthew Dixon Cowles for the original inspiration and examples.
+

Doc-26/library/email.charset.rst

+:mod:`email`: Representing character sets
+-----------------------------------------
+
 .. module:: email.charset
    :synopsis: Character Sets
 

Doc-26/library/email.encoders.rst

+:mod:`email`: Encoders
+----------------------
+
 .. module:: email.encoders
    :synopsis: Encoders for email message payloads.
 

Doc-26/library/email.errors.rst

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

Doc-26/library/email.generator.rst

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

Doc-26/library/email.header.rst

+:mod:`email`: Internationalized headers
+---------------------------------------
+
 .. module:: email.header
    :synopsis: Representing non-ASCII headers
 

Doc-26/library/email.iterators.rst

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

Doc-26/library/email.message.rst

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

Doc-26/library/email.mime.rst

+:mod:`email`: Creating email and MIME objects from scratch
+----------------------------------------------------------
+
 .. module:: email.mime.text
 
 

Doc-26/library/email.parser.rst

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

Doc-26/library/email.rst

 examples.  For users of the older :mod:`mimelib` package, or previous versions
 of the :mod:`email` package, a section on differences and porting is provided.
 
+Contents of the :mod:`email` package documentation:
+
+.. toctree::
+
+   email.message.rst
+   email.parser.rst
+   email.generator.rst
+   email.mime.rst
+   email.header.rst
+   email.charset.rst
+   email.encoders.rst
+   email.errors.rst
+   email.util.rst
+   email.iterators.rst
+   email-examples.rst
+
 
 .. seealso::
 
       NNTP protocol client
 
 
-Representing an email message
------------------------------
-
-
-.. include:: email.message.rst
-
-
-Parsing email messages
-----------------------
-
-
-.. include:: email.parser.rst
-
-
-Generating MIME documents
--------------------------
-
-
-.. include:: email.generator.rst
-
-
-Creating email and MIME objects from scratch
---------------------------------------------
-
-
-.. include:: email.mime.rst
-
-
-Internationalized headers
--------------------------
-
-
-.. include:: email.header.rst
-
-
-Representing character sets
----------------------------
-
-
-.. include:: email.charset.rst
-
-
-Encoders
---------
-
-
-.. include:: email.encoders.rst
-
-
-Exception and Defect classes
-----------------------------
-
-
-.. include:: email.errors.rst
-
-
-Miscellaneous utilities
------------------------
-
-
-.. include:: email.util.rst
-
-
-Iterators
----------
-
-
-.. include:: email.iterators.rst
-
-
 .. _email-pkg-history:
 
 Package History
 closely supported in the :func:`body_line_iterator` function in the
 :mod:`email.iterators` module.
 
-
-Examples
---------
-
-Here are a few examples of how to use the :mod:`email` package to read, write,
-and send simple email messages, as well as more complex MIME messages.
-
-First, let's see how to create and send a simple text message:
-
-
-.. include:: ../includes/email-simple.py
-   :literal:
-
-Here's an example of how to send a MIME message containing a bunch of family
-pictures that may be residing in a directory:
-
-
-.. include:: ../includes/email-mime.py
-   :literal:
-
-Here's an example of how to send the entire contents of a directory as an email
-message:  [#]_
-
-
-.. include:: ../includes/email-dir.py
-   :literal:
-
-And finally, here's an example of how to unpack a MIME message like the one
-above, into a directory of files:
-
-
-.. include:: ../includes/email-unpack.py
-   :literal:
-
 .. rubric:: Footnotes
 
 .. [#] Delivery Status Notifications (DSN) are defined in :rfc:`1894`.
-
-.. [#] Thanks to Matthew Dixon Cowles for the original inspiration and examples.
-

Doc-26/library/email.util.rst

+:mod:`email`: Miscellaneous utilities
+-------------------------------------
+
 .. module:: email.utils
    :synopsis: Miscellaneous email package utilities.
 
 * adjust all literal include paths
 * remove all non-literal includes
 * fix all duplicate labels and undefined label references
-* fix the email package docs: add a toctree
 * split very large files and add toctrees
 * integrate standalone HOWTOs
 * find out which files get "comments disabled" metadata
 * write "About these documents"
 * finish "Documenting Python"
 * extend copyright.rst
-* fix the "quadruple" index term
-* fix :file: and |version| in install
+* fix :file: and |version| in install

Doc-3k/library/email.charset.rst

+:mod:`email`: Representing character sets
+-----------------------------------------
+
 .. module:: email.charset
    :synopsis: Character Sets
 

Doc-3k/library/email.encoders.rst

+:mod:`email`: Encoders
+----------------------
+
 .. module:: email.encoders
    :synopsis: Encoders for email message payloads.
 

Doc-3k/library/email.errors.rst

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

Doc-3k/library/email.generator.rst

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

Doc-3k/library/email.header.rst

+:mod:`email`: Internationalized headers
+---------------------------------------
+
 .. module:: email.header
    :synopsis: Representing non-ASCII headers
 

Doc-3k/library/email.iterators.rst

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

Doc-3k/library/email.message.rst

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

Doc-3k/library/email.mime.rst

+:mod:`email`: Creating email and MIME objects from scratch
+----------------------------------------------------------
+
 .. module:: email.mime.text
 
 

Doc-3k/library/email.parser.rst

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

Doc-3k/library/email.rst

 examples.  For users of the older :mod:`mimelib` package, or previous versions
 of the :mod:`email` package, a section on differences and porting is provided.
 
+Contents of the :mod:`email` package documentation:
+
+.. toctree::
+
+   email.message.rst
+   email.parser.rst
+   email.generator.rst
+   email.mime.rst
+   email.header.rst
+   email.charset.rst
+   email.encoders.rst
+   email.errors.rst
+   email.util.rst
+   email.iterators.rst
+   email-examples.rst
+
 
 .. seealso::
 
       NNTP protocol client
 
 
-Representing an email message
------------------------------
-
-
-.. include:: email.message.rst
-
-
-Parsing email messages
-----------------------
-
-
-.. include:: email.parser.rst
-
-
-Generating MIME documents
--------------------------
-
-
-.. include:: email.generator.rst
-
-
-Creating email and MIME objects from scratch
---------------------------------------------
-
-
-.. include:: email.mime.rst
-
-
-Internationalized headers
--------------------------
-
-
-.. include:: email.header.rst
-
-
-Representing character sets
----------------------------
-
-
-.. include:: email.charset.rst
-
-
-Encoders
---------
-
-
-.. include:: email.encoders.rst
-
-
-Exception and Defect classes
-----------------------------
-
-
-.. include:: email.errors.rst
-
-
-Miscellaneous utilities
------------------------
-
-
-.. include:: email.util.rst
-
-
-Iterators
----------
-
-
-.. include:: email.iterators.rst
-
-
 .. _email-pkg-history:
 
 Package History
 closely supported in the :func:`body_line_iterator` function in the
 :mod:`email.iterators` module.
 
-
-Examples
---------
-
-Here are a few examples of how to use the :mod:`email` package to read, write,
-and send simple email messages, as well as more complex MIME messages.
-
-First, let's see how to create and send a simple text message:
-
-
-.. include:: ../includes/email-simple.py
-   :literal:
-
-Here's an example of how to send a MIME message containing a bunch of family
-pictures that may be residing in a directory:
-
-
-.. include:: ../includes/email-mime.py
-   :literal:
-
-Here's an example of how to send the entire contents of a directory as an email
-message:  [#]_
-
-
-.. include:: ../includes/email-dir.py
-   :literal:
-
-And finally, here's an example of how to unpack a MIME message like the one
-above, into a directory of files:
-
-
-.. include:: ../includes/email-unpack.py
-   :literal:
-
 .. rubric:: Footnotes
 
 .. [#] Delivery Status Notifications (DSN) are defined in :rfc:`1894`.
-
-.. [#] Thanks to Matthew Dixon Cowles for the original inspiration and examples.
-

Doc-3k/library/email.util.rst

+:mod:`email`: Miscellaneous utilities
+-------------------------------------
+
 .. module:: email.utils
    :synopsis: Miscellaneous email package utilities.
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.