Break up the 'someos' docs classification based on a more user-focused scheme, including creation of a separate 'Concurrent Execution' section

This commit is contained in:
Nick Coghlan 2012-08-20 18:05:46 +10:00
parent 273069cf7d
commit bac9a53d00
7 changed files with 44 additions and 30 deletions

View File

@ -0,0 +1,31 @@
.. _concurrency:
********************
Concurrent Execution
********************
The modules described in this chapter provide support for concurrent
execution of code. The appropriate choice of tool will depend on the
task to be executed (CPU bound vs IO bound) and preferred style of
development (event driven cooperative multitasking vs preemptive
multitasking) Here's an overview:
.. toctree::
threading.rst
multiprocessing.rst
concurrent.futures.rst
subprocess.rst
sched.rst
queue.rst
select.rst
The following are support modules for some of the above services:
.. toctree::
dummy_threading.rst
_thread.rst
_dummy_thread.rst

View File

@ -25,8 +25,6 @@ The following modules are documented in this chapter:
heapq.rst
bisect.rst
array.rst
sched.rst
queue.rst
weakref.rst
types.rst
copy.rst

View File

@ -57,7 +57,7 @@ the `Python Package Index <http://pypi.python.org/pypi>`_.
fileformats.rst
crypto.rst
allos.rst
someos.rst
concurrency.rst
ipc.rst
netdata.rst
markup.rst

View File

@ -8,7 +8,7 @@ The modules described in this chapter provide mechanisms for different processes
to communicate.
Some modules only work for two processes that are on the same machine, e.g.
:mod:`signal` and :mod:`subprocess`. Other modules support networking protocols
:mod:`signal` and :mod:`mmap`. Other modules support networking protocols
that two or more processes can used to communicate across machines.
The list of modules described in this chapter is:
@ -16,9 +16,9 @@ The list of modules described in this chapter is:
.. toctree::
subprocess.rst
socket.rst
ssl.rst
signal.rst
asyncore.rst
asynchat.rst
signal.rst
mmap.rst

View File

@ -1,24 +0,0 @@
.. _someos:
**********************************
Optional Operating System Services
**********************************
The modules described in this chapter provide interfaces to operating system
features that are available on selected operating systems only. The interfaces
are generally modeled after the Unix or C interfaces but they are available on
some other systems as well (e.g. Windows). Here's an overview:
.. toctree::
select.rst
threading.rst
multiprocessing.rst
concurrent.futures.rst
mmap.rst
readline.rst
rlcompleter.rst
dummy_threading.rst
_thread.rst
_dummy_thread.rst

View File

@ -21,4 +21,6 @@ Python's built-in string type in :ref:`textseq`.
textwrap.rst
unicodedata.rst
stringprep.rst
readline.rst
rlcompleter.rst

View File

@ -55,6 +55,13 @@ Tools/Demos
Documentation
-------------
- Create a 'Concurrent Execution' section in the docs, and split up the
'Optional Operating System Services' section to use a more user-centric
classification scheme (splitting them across the new CE section, IPC and
text processing). Operating system limitatons can be reflected with
the Sphinx :platform: tag, it doesn't make sense as part of the Table of
Contents.
- Issue #4966: Bring the sequence docs up to date for the Py3k transition
and the many language enhancements since they were original written