diff --git a/Doc-26/TODO b/Doc-26/TODO index 16f656675..e96ef77ed 100644 --- a/Doc-26/TODO +++ b/Doc-26/TODO @@ -4,7 +4,6 @@ To do after conversion * split very large files and add toctrees * integrate standalone HOWTOs * find out which files get "comments disabled" metadata -* add synopses for each module * write "About these documents" * finish "Documenting Python" * extend copyright.rst diff --git a/Doc-26/library/cgi.rst b/Doc-26/library/cgi.rst index 1721ec0ee..97c8843b8 100644 --- a/Doc-26/library/cgi.rst +++ b/Doc-26/library/cgi.rst @@ -3,8 +3,7 @@ ================================================ .. module:: cgi - - + :synopsis: Helpers for running Python scripts via the Common Gateway Interface. .. index:: @@ -13,13 +12,10 @@ pair: HTTP; protocol pair: MIME; headers single: URL - -.. index:: single: Common Gateway Interface + single: Common Gateway Interface Support module for Common Gateway Interface (CGI) scripts. -.. % - This module defines a number of utilities for use by CGI scripts written in Python. diff --git a/Doc-26/library/code.rst b/Doc-26/library/code.rst index 0e6eac795..9155b4b1e 100644 --- a/Doc-26/library/code.rst +++ b/Doc-26/library/code.rst @@ -3,7 +3,7 @@ ======================================== .. module:: code - + :synopsis: Facilities to implement read-eval-print loops. diff --git a/Doc-26/library/cookielib.rst b/Doc-26/library/cookielib.rst index 40c3f6d0f..e77da5c6a 100644 --- a/Doc-26/library/cookielib.rst +++ b/Doc-26/library/cookielib.rst @@ -3,6 +3,7 @@ ===================================================== .. module:: cookielib + :synopsis: Classes for automatic handling of HTTP cookies. .. moduleauthor:: John J. Lee .. sectionauthor:: John J. Lee diff --git a/Doc-26/library/doctest.rst b/Doc-26/library/doctest.rst index da9aacde5..78c2a4fc0 100644 --- a/Doc-26/library/doctest.rst +++ b/Doc-26/library/doctest.rst @@ -1,16 +1,14 @@ - :mod:`doctest` --- Test interactive Python examples =================================================== .. module:: doctest + :synopsis: Test pieces of code within docstrings. .. moduleauthor:: Tim Peters .. sectionauthor:: Tim Peters .. sectionauthor:: Moshe Zadka .. sectionauthor:: Edward Loper - - The :mod:`doctest` module searches for pieces of text that look like interactive Python sessions, and then executes those sessions to verify that they work exactly as shown. There are several common ways to use doctest: diff --git a/Doc-26/library/email.mime.rst b/Doc-26/library/email.mime.rst index 90fec4889..6f1b0aea9 100644 --- a/Doc-26/library/email.mime.rst +++ b/Doc-26/library/email.mime.rst @@ -1,7 +1,8 @@ :mod:`email`: Creating email and MIME objects from scratch ---------------------------------------------------------- -.. module:: email.mime.text +.. module:: email.mime + :synopsis: Build MIME messages. Ordinarily, you get a message object structure by passing a file or some text to diff --git a/Doc-26/library/fileinput.rst b/Doc-26/library/fileinput.rst index 1e27aa3ab..0c7b30c8c 100644 --- a/Doc-26/library/fileinput.rst +++ b/Doc-26/library/fileinput.rst @@ -1,14 +1,12 @@ - :mod:`fileinput` --- Iterate over lines from multiple input streams =================================================================== .. module:: fileinput + :synopsis: Loop over standard input or a list of files. .. moduleauthor:: Guido van Rossum .. sectionauthor:: Fred L. Drake, Jr. - - This module implements a helper class and functions to quickly write a loop over standard input or a list of files. diff --git a/Doc-26/library/functools.rst b/Doc-26/library/functools.rst index 46d03e355..ed40174ef 100644 --- a/Doc-26/library/functools.rst +++ b/Doc-26/library/functools.rst @@ -1,18 +1,14 @@ - -:mod:`functools` --- Higher order functions and operations on callable objects. -=============================================================================== +:mod:`functools` --- Higher order functions and operations on callable objects +============================================================================== .. module:: functools + :synopsis: Higher order functions and operations on callable objects. .. moduleauthor:: Peter Harris .. moduleauthor:: Raymond Hettinger .. moduleauthor:: Nick Coghlan .. sectionauthor:: Peter Harris -.. % standard library, in Python - - - .. versionadded:: 2.5 The :mod:`functools` module is for higher-order functions: functions that act on diff --git a/Doc-26/library/logging.rst b/Doc-26/library/logging.rst index 057e6b362..6dd2a98f9 100644 --- a/Doc-26/library/logging.rst +++ b/Doc-26/library/logging.rst @@ -1,8 +1,8 @@ - :mod:`logging` --- Logging facility for Python ============================================== .. module:: logging + :synopsis: Flexible error logging system for applications. .. moduleauthor:: Vinay Sajip diff --git a/Doc-26/library/mailcap.rst b/Doc-26/library/mailcap.rst index 6b9891132..8dcb1ec61 100644 --- a/Doc-26/library/mailcap.rst +++ b/Doc-26/library/mailcap.rst @@ -1,9 +1,8 @@ - -:mod:`mailcap` --- Mailcap file handling. -========================================= +:mod:`mailcap` --- Mailcap file handling +======================================== .. module:: mailcap - + :synopsis: Mailcap file handling. diff --git a/Doc-26/library/mimewriter.rst b/Doc-26/library/mimewriter.rst index ec018621c..cf93473e4 100644 --- a/Doc-26/library/mimewriter.rst +++ b/Doc-26/library/mimewriter.rst @@ -1,9 +1,8 @@ - :mod:`MimeWriter` --- Generic MIME file writer ============================================== .. module:: MimeWriter - + :synopsis: Write MIME format files. .. sectionauthor:: Christopher G. Petrilli diff --git a/Doc-26/library/operator.rst b/Doc-26/library/operator.rst index cc6679e2d..e63bd5acd 100644 --- a/Doc-26/library/operator.rst +++ b/Doc-26/library/operator.rst @@ -1,13 +1,12 @@ - -:mod:`operator` --- Standard operators as functions. -==================================================== +:mod:`operator` --- Standard operators as functions +=================================================== .. module:: operator + :synopsis: Functions corresponding to the standard operators. .. sectionauthor:: Skip Montanaro - The :mod:`operator` module exports a set of functions implemented in C corresponding to the intrinsic operators of Python. For example, ``operator.add(x, y)`` is equivalent to the expression ``x+y``. The function diff --git a/Doc-26/library/os.path.rst b/Doc-26/library/os.path.rst index 75ab00c46..98989957e 100644 --- a/Doc-26/library/os.path.rst +++ b/Doc-26/library/os.path.rst @@ -3,8 +3,7 @@ ================================================ .. module:: os.path - - + :synopsis: Operations on pathnames. .. index:: single: path; operations diff --git a/Doc-26/library/profile.rst b/Doc-26/library/profile.rst index f27614c56..41b201a86 100644 --- a/Doc-26/library/profile.rst +++ b/Doc-26/library/profile.rst @@ -355,11 +355,9 @@ Analysis of the profiler data is done using the :class:`Stats` class. The :class:`Stats` class is defined in the :mod:`pstats` module. + .. module:: pstats - - -.. % now switch modules.... -.. % (This \stmodindex use may be hard to change ;-( ) + :synopsis: Statistics object for use with the profiler. .. class:: Stats(filename[, stream=sys.stdout[, ...]]) diff --git a/Doc-26/library/py_compile.rst b/Doc-26/library/py_compile.rst index a7dc14692..c81584660 100644 --- a/Doc-26/library/py_compile.rst +++ b/Doc-26/library/py_compile.rst @@ -1,9 +1,8 @@ - :mod:`py_compile` --- Compile Python source files ================================================= .. module:: py_compile - + :synopsis: Generate byte-code files from Python source files. .. % Documentation based on module docstrings, by Fred L. Drake, Jr. .. % diff --git a/Doc-26/library/re.rst b/Doc-26/library/re.rst index ecb11f88b..1822b55ea 100644 --- a/Doc-26/library/re.rst +++ b/Doc-26/library/re.rst @@ -3,6 +3,7 @@ =========================================== .. module:: re + :synopsis: Regular expression operations. .. moduleauthor:: Fredrik Lundh .. sectionauthor:: Andrew M. Kuchling diff --git a/Doc-26/library/runpy.rst b/Doc-26/library/runpy.rst index a86d81a0b..ce8aa990e 100644 --- a/Doc-26/library/runpy.rst +++ b/Doc-26/library/runpy.rst @@ -1,15 +1,11 @@ - -:mod:`runpy` --- Locating and executing Python modules. -======================================================= +:mod:`runpy` --- Locating and executing Python modules +====================================================== .. module:: runpy + :synopsis: Locate and run Python modules without importing them first. .. moduleauthor:: Nick Coghlan -.. % standard library, in Python - - - .. versionadded:: 2.5 The :mod:`runpy` module is used to locate and run Python modules without diff --git a/Doc-26/library/smtpd.rst b/Doc-26/library/smtpd.rst index 873dd00e8..8927a64f4 100644 --- a/Doc-26/library/smtpd.rst +++ b/Doc-26/library/smtpd.rst @@ -1,9 +1,8 @@ - :mod:`smtpd` --- SMTP Server ============================ .. module:: smtpd - + :synopsis: A SMTP server implementation in Python. .. moduleauthor:: Barry Warsaw .. sectionauthor:: Moshe Zadka diff --git a/Doc-26/library/struct.rst b/Doc-26/library/struct.rst index 18a4c234e..446f0f8f0 100644 --- a/Doc-26/library/struct.rst +++ b/Doc-26/library/struct.rst @@ -3,9 +3,7 @@ ========================================================= .. module:: struct - - - + :synopsis: Interpret strings as packed binary data. .. index:: pair: C; structures diff --git a/Doc-26/library/urllib2.rst b/Doc-26/library/urllib2.rst index 11695ba94..50aa80250 100644 --- a/Doc-26/library/urllib2.rst +++ b/Doc-26/library/urllib2.rst @@ -1,14 +1,12 @@ - :mod:`urllib2` --- extensible library for opening URLs ====================================================== .. module:: urllib2 + :synopsis: Next generation URL opening library. .. moduleauthor:: Jeremy Hylton .. sectionauthor:: Moshe Zadka - - The :mod:`urllib2` module defines functions and classes which help in opening URLs (mostly HTTP) in a complex world --- basic and digest authentication, redirections, cookies and more. diff --git a/Doc-26/library/urlparse.rst b/Doc-26/library/urlparse.rst index d068a1511..c6bc82b7b 100644 --- a/Doc-26/library/urlparse.rst +++ b/Doc-26/library/urlparse.rst @@ -1,10 +1,8 @@ - :mod:`urlparse` --- Parse URLs into components ============================================== .. module:: urlparse - - + :synopsis: Parse URLs into or assemble them from components. .. index:: diff --git a/Doc-26/library/wsgiref.rst b/Doc-26/library/wsgiref.rst index c4f59a03b..25d0f3a07 100644 --- a/Doc-26/library/wsgiref.rst +++ b/Doc-26/library/wsgiref.rst @@ -1,9 +1,8 @@ - :mod:`wsgiref` --- WSGI Utilities and Reference Implementation ============================================================== .. module:: wsgiref - :synopsis: WSGI Utilities and Reference Implementation + :synopsis: WSGI Utilities and Reference Implementation. .. moduleauthor:: Phillip J. Eby .. sectionauthor:: Phillip J. Eby @@ -37,6 +36,7 @@ and other resources. ------------------------------------------------- .. module:: wsgiref.util + :synopsis: WSGI environment utilities. This module provides a variety of utility functions for working with WSGI @@ -142,6 +142,7 @@ also provides these miscellaneous utilities: ---------------------------------------------------- .. module:: wsgiref.headers + :synopsis: WSGI response header tools. This module provides a single class, :class:`Headers`, for convenient @@ -221,6 +222,7 @@ manipulation of WSGI response headers using a mapping-like interface. --------------------------------------------------------- .. module:: wsgiref.simple_server + :synopsis: A simple WSGI HTTP server. This module implements a simple HTTP server (based on :mod:`BaseHTTPServer`) @@ -232,7 +234,7 @@ request. (E.g., using the :func:`shift_path_info` function from :mod:`wsgiref.util`.) -.. function:: make_server(host, port, app [, server_class=:class:`WSGIServer` [, handler_class=:class:`WSGIRequestHandler`]]) +.. function:: make_server(host, port, app [, server_class=WSGIServer [, handler_class=:class:`WSGIRequestHandler`]]) Create a new WSGI server listening on *host* and *port*, accepting connections for *app*. The return value is an instance of the supplied *server_class*, and @@ -327,10 +329,11 @@ request. (E.g., using the :func:`shift_path_info` function from interface. -:mod:`wsgiref.validate` -- WSGI conformance checker ---------------------------------------------------- +:mod:`wsgiref.validate` --- WSGI conformance checker +---------------------------------------------------- .. module:: wsgiref.validate + :synopsis: WSGI conformance checker. When creating new WSGI application objects, frameworks, servers, or middleware, @@ -375,6 +378,7 @@ Paste" library. ------------------------------------------------------ .. module:: wsgiref.handlers + :synopsis: WSGI server/gateway base classes. This module provides base handler classes for implementing WSGI servers and diff --git a/Doc-3k/TODO b/Doc-3k/TODO index 16f656675..e96ef77ed 100644 --- a/Doc-3k/TODO +++ b/Doc-3k/TODO @@ -4,7 +4,6 @@ To do after conversion * split very large files and add toctrees * integrate standalone HOWTOs * find out which files get "comments disabled" metadata -* add synopses for each module * write "About these documents" * finish "Documenting Python" * extend copyright.rst diff --git a/Doc-3k/library/cgi.rst b/Doc-3k/library/cgi.rst index 1721ec0ee..97c8843b8 100644 --- a/Doc-3k/library/cgi.rst +++ b/Doc-3k/library/cgi.rst @@ -3,8 +3,7 @@ ================================================ .. module:: cgi - - + :synopsis: Helpers for running Python scripts via the Common Gateway Interface. .. index:: @@ -13,13 +12,10 @@ pair: HTTP; protocol pair: MIME; headers single: URL - -.. index:: single: Common Gateway Interface + single: Common Gateway Interface Support module for Common Gateway Interface (CGI) scripts. -.. % - This module defines a number of utilities for use by CGI scripts written in Python. diff --git a/Doc-3k/library/code.rst b/Doc-3k/library/code.rst index 9a4e8dae8..811e1fd9c 100644 --- a/Doc-3k/library/code.rst +++ b/Doc-3k/library/code.rst @@ -3,7 +3,7 @@ ======================================== .. module:: code - + :synopsis: Facilities to implement read-eval-print loops. diff --git a/Doc-3k/library/cookielib.rst b/Doc-3k/library/cookielib.rst index 40c3f6d0f..e77da5c6a 100644 --- a/Doc-3k/library/cookielib.rst +++ b/Doc-3k/library/cookielib.rst @@ -3,6 +3,7 @@ ===================================================== .. module:: cookielib + :synopsis: Classes for automatic handling of HTTP cookies. .. moduleauthor:: John J. Lee .. sectionauthor:: John J. Lee diff --git a/Doc-3k/library/doctest.rst b/Doc-3k/library/doctest.rst index da9aacde5..78c2a4fc0 100644 --- a/Doc-3k/library/doctest.rst +++ b/Doc-3k/library/doctest.rst @@ -1,16 +1,14 @@ - :mod:`doctest` --- Test interactive Python examples =================================================== .. module:: doctest + :synopsis: Test pieces of code within docstrings. .. moduleauthor:: Tim Peters .. sectionauthor:: Tim Peters .. sectionauthor:: Moshe Zadka .. sectionauthor:: Edward Loper - - The :mod:`doctest` module searches for pieces of text that look like interactive Python sessions, and then executes those sessions to verify that they work exactly as shown. There are several common ways to use doctest: diff --git a/Doc-3k/library/email.mime.rst b/Doc-3k/library/email.mime.rst index 90fec4889..6f1b0aea9 100644 --- a/Doc-3k/library/email.mime.rst +++ b/Doc-3k/library/email.mime.rst @@ -1,7 +1,8 @@ :mod:`email`: Creating email and MIME objects from scratch ---------------------------------------------------------- -.. module:: email.mime.text +.. module:: email.mime + :synopsis: Build MIME messages. Ordinarily, you get a message object structure by passing a file or some text to diff --git a/Doc-3k/library/fileinput.rst b/Doc-3k/library/fileinput.rst index 1e27aa3ab..0c7b30c8c 100644 --- a/Doc-3k/library/fileinput.rst +++ b/Doc-3k/library/fileinput.rst @@ -1,14 +1,12 @@ - :mod:`fileinput` --- Iterate over lines from multiple input streams =================================================================== .. module:: fileinput + :synopsis: Loop over standard input or a list of files. .. moduleauthor:: Guido van Rossum .. sectionauthor:: Fred L. Drake, Jr. - - This module implements a helper class and functions to quickly write a loop over standard input or a list of files. diff --git a/Doc-3k/library/functools.rst b/Doc-3k/library/functools.rst index 4c1a20290..78f111013 100644 --- a/Doc-3k/library/functools.rst +++ b/Doc-3k/library/functools.rst @@ -1,18 +1,14 @@ - -:mod:`functools` --- Higher order functions and operations on callable objects. -=============================================================================== +:mod:`functools` --- Higher order functions and operations on callable objects +============================================================================== .. module:: functools + :synopsis: Higher order functions and operations on callable objects. .. moduleauthor:: Peter Harris .. moduleauthor:: Raymond Hettinger .. moduleauthor:: Nick Coghlan .. sectionauthor:: Peter Harris -.. % standard library, in Python - - - .. versionadded:: 2.5 The :mod:`functools` module is for higher-order functions: functions that act on diff --git a/Doc-3k/library/logging.rst b/Doc-3k/library/logging.rst index 057e6b362..6dd2a98f9 100644 --- a/Doc-3k/library/logging.rst +++ b/Doc-3k/library/logging.rst @@ -1,8 +1,8 @@ - :mod:`logging` --- Logging facility for Python ============================================== .. module:: logging + :synopsis: Flexible error logging system for applications. .. moduleauthor:: Vinay Sajip diff --git a/Doc-3k/library/mailcap.rst b/Doc-3k/library/mailcap.rst index 6b9891132..8dcb1ec61 100644 --- a/Doc-3k/library/mailcap.rst +++ b/Doc-3k/library/mailcap.rst @@ -1,9 +1,8 @@ - -:mod:`mailcap` --- Mailcap file handling. -========================================= +:mod:`mailcap` --- Mailcap file handling +======================================== .. module:: mailcap - + :synopsis: Mailcap file handling. diff --git a/Doc-3k/library/operator.rst b/Doc-3k/library/operator.rst index 5f6e9f917..add5f0a18 100644 --- a/Doc-3k/library/operator.rst +++ b/Doc-3k/library/operator.rst @@ -1,13 +1,12 @@ - -:mod:`operator` --- Standard operators as functions. -==================================================== +:mod:`operator` --- Standard operators as functions +=================================================== .. module:: operator + :synopsis: Functions corresponding to the standard operators. .. sectionauthor:: Skip Montanaro - The :mod:`operator` module exports a set of functions implemented in C corresponding to the intrinsic operators of Python. For example, ``operator.add(x, y)`` is equivalent to the expression ``x+y``. The function diff --git a/Doc-3k/library/os.path.rst b/Doc-3k/library/os.path.rst index 75ab00c46..98989957e 100644 --- a/Doc-3k/library/os.path.rst +++ b/Doc-3k/library/os.path.rst @@ -3,8 +3,7 @@ ================================================ .. module:: os.path - - + :synopsis: Operations on pathnames. .. index:: single: path; operations diff --git a/Doc-3k/library/profile.rst b/Doc-3k/library/profile.rst index 82b9f8839..5848174ec 100644 --- a/Doc-3k/library/profile.rst +++ b/Doc-3k/library/profile.rst @@ -355,11 +355,9 @@ Analysis of the profiler data is done using the :class:`Stats` class. The :class:`Stats` class is defined in the :mod:`pstats` module. + .. module:: pstats - - -.. % now switch modules.... -.. % (This \stmodindex use may be hard to change ;-( ) + :synopsis: Statistics object for use with the profiler. .. class:: Stats(filename[, stream=sys.stdout[, ...]]) diff --git a/Doc-3k/library/py_compile.rst b/Doc-3k/library/py_compile.rst index a7dc14692..c81584660 100644 --- a/Doc-3k/library/py_compile.rst +++ b/Doc-3k/library/py_compile.rst @@ -1,9 +1,8 @@ - :mod:`py_compile` --- Compile Python source files ================================================= .. module:: py_compile - + :synopsis: Generate byte-code files from Python source files. .. % Documentation based on module docstrings, by Fred L. Drake, Jr. .. % diff --git a/Doc-3k/library/re.rst b/Doc-3k/library/re.rst index ecb11f88b..1822b55ea 100644 --- a/Doc-3k/library/re.rst +++ b/Doc-3k/library/re.rst @@ -3,6 +3,7 @@ =========================================== .. module:: re + :synopsis: Regular expression operations. .. moduleauthor:: Fredrik Lundh .. sectionauthor:: Andrew M. Kuchling diff --git a/Doc-3k/library/runpy.rst b/Doc-3k/library/runpy.rst index 6d06151c2..1bcac410f 100644 --- a/Doc-3k/library/runpy.rst +++ b/Doc-3k/library/runpy.rst @@ -1,15 +1,11 @@ - -:mod:`runpy` --- Locating and executing Python modules. -======================================================= +:mod:`runpy` --- Locating and executing Python modules +====================================================== .. module:: runpy + :synopsis: Locate and run Python modules without importing them first. .. moduleauthor:: Nick Coghlan -.. % standard library, in Python - - - .. versionadded:: 2.5 The :mod:`runpy` module is used to locate and run Python modules without diff --git a/Doc-3k/library/smtpd.rst b/Doc-3k/library/smtpd.rst index 873dd00e8..8927a64f4 100644 --- a/Doc-3k/library/smtpd.rst +++ b/Doc-3k/library/smtpd.rst @@ -1,9 +1,8 @@ - :mod:`smtpd` --- SMTP Server ============================ .. module:: smtpd - + :synopsis: A SMTP server implementation in Python. .. moduleauthor:: Barry Warsaw .. sectionauthor:: Moshe Zadka diff --git a/Doc-3k/library/struct.rst b/Doc-3k/library/struct.rst index 18a4c234e..446f0f8f0 100644 --- a/Doc-3k/library/struct.rst +++ b/Doc-3k/library/struct.rst @@ -3,9 +3,7 @@ ========================================================= .. module:: struct - - - + :synopsis: Interpret strings as packed binary data. .. index:: pair: C; structures diff --git a/Doc-3k/library/urllib2.rst b/Doc-3k/library/urllib2.rst index 11695ba94..50aa80250 100644 --- a/Doc-3k/library/urllib2.rst +++ b/Doc-3k/library/urllib2.rst @@ -1,14 +1,12 @@ - :mod:`urllib2` --- extensible library for opening URLs ====================================================== .. module:: urllib2 + :synopsis: Next generation URL opening library. .. moduleauthor:: Jeremy Hylton .. sectionauthor:: Moshe Zadka - - The :mod:`urllib2` module defines functions and classes which help in opening URLs (mostly HTTP) in a complex world --- basic and digest authentication, redirections, cookies and more. diff --git a/Doc-3k/library/urlparse.rst b/Doc-3k/library/urlparse.rst index d068a1511..c6bc82b7b 100644 --- a/Doc-3k/library/urlparse.rst +++ b/Doc-3k/library/urlparse.rst @@ -1,10 +1,8 @@ - :mod:`urlparse` --- Parse URLs into components ============================================== .. module:: urlparse - - + :synopsis: Parse URLs into or assemble them from components. .. index:: diff --git a/Doc-3k/library/wsgiref.rst b/Doc-3k/library/wsgiref.rst index c4f59a03b..25d0f3a07 100644 --- a/Doc-3k/library/wsgiref.rst +++ b/Doc-3k/library/wsgiref.rst @@ -1,9 +1,8 @@ - :mod:`wsgiref` --- WSGI Utilities and Reference Implementation ============================================================== .. module:: wsgiref - :synopsis: WSGI Utilities and Reference Implementation + :synopsis: WSGI Utilities and Reference Implementation. .. moduleauthor:: Phillip J. Eby .. sectionauthor:: Phillip J. Eby @@ -37,6 +36,7 @@ and other resources. ------------------------------------------------- .. module:: wsgiref.util + :synopsis: WSGI environment utilities. This module provides a variety of utility functions for working with WSGI @@ -142,6 +142,7 @@ also provides these miscellaneous utilities: ---------------------------------------------------- .. module:: wsgiref.headers + :synopsis: WSGI response header tools. This module provides a single class, :class:`Headers`, for convenient @@ -221,6 +222,7 @@ manipulation of WSGI response headers using a mapping-like interface. --------------------------------------------------------- .. module:: wsgiref.simple_server + :synopsis: A simple WSGI HTTP server. This module implements a simple HTTP server (based on :mod:`BaseHTTPServer`) @@ -232,7 +234,7 @@ request. (E.g., using the :func:`shift_path_info` function from :mod:`wsgiref.util`.) -.. function:: make_server(host, port, app [, server_class=:class:`WSGIServer` [, handler_class=:class:`WSGIRequestHandler`]]) +.. function:: make_server(host, port, app [, server_class=WSGIServer [, handler_class=:class:`WSGIRequestHandler`]]) Create a new WSGI server listening on *host* and *port*, accepting connections for *app*. The return value is an instance of the supplied *server_class*, and @@ -327,10 +329,11 @@ request. (E.g., using the :func:`shift_path_info` function from interface. -:mod:`wsgiref.validate` -- WSGI conformance checker ---------------------------------------------------- +:mod:`wsgiref.validate` --- WSGI conformance checker +---------------------------------------------------- .. module:: wsgiref.validate + :synopsis: WSGI conformance checker. When creating new WSGI application objects, frameworks, servers, or middleware, @@ -375,6 +378,7 @@ Paste" library. ------------------------------------------------------ .. module:: wsgiref.handlers + :synopsis: WSGI server/gateway base classes. This module provides base handler classes for implementing WSGI servers and