Commit 9bc5e65d authored by Jason Madden's avatar Jason Madden

Minor doc reorganization.

Surface the older changelogs more directly, and also surfate the module listing more directly.

Fixes #1700.
parent 46b32bc7
...@@ -380,6 +380,3 @@ Misc ...@@ -380,6 +380,3 @@ Misc
---- ----
- See :issue:`1367`. - See :issue:`1367`.
----
============================ =============================================
The Event Loop and the Hub ``gevent.hub`` - The Event Loop and the Hub
============================ =============================================
.. module:: gevent.hub .. module:: gevent.hub
......
...@@ -10,9 +10,16 @@ The most common functions and classes are available in the ...@@ -10,9 +10,16 @@ The most common functions and classes are available in the
Please read :doc:`/intro` for an introduction to the concepts Please read :doc:`/intro` for an introduction to the concepts
discussed here. discussed here.
.. seealso:: :mod:`gevent.util`
.. seealso:: :doc:`/configuration`
For configuring gevent using the environment or the
``gevent.config`` object.
.. autodata:: __version__ .. autodata:: __version__
.. seealso:: :mod:`gevent.util`
Working With Greenlets Working With Greenlets
====================== ======================
......
====================== ===============================================
Cooperative Timeouts Cooperative Timeouts Using ``gevent.Timeout``
====================== ===============================================
Cooperative timeouts can be implemented with the Cooperative timeouts can be implemented with the
:class:`gevent.Timeout` class, and the helper function :class:`gevent.Timeout` class, and the helper function
......
...@@ -2,8 +2,14 @@ ...@@ -2,8 +2,14 @@
API reference API reference
=============== ===============
Functional Areas
================
This section of the document groups gevent APIs by functional area.
For an alphabetical listing by module, see :ref:`api_module_listing`.
High-level concepts High-level concepts
=================== -------------------
.. toctree:: .. toctree::
gevent gevent
...@@ -13,7 +19,7 @@ High-level concepts ...@@ -13,7 +19,7 @@ High-level concepts
.. _networking: .. _networking:
Networking interfaces Networking interfaces
===================== ---------------------
.. toctree:: .. toctree::
...@@ -23,7 +29,7 @@ Networking interfaces ...@@ -23,7 +29,7 @@ Networking interfaces
gevent.selectors gevent.selectors
Synchronization primitives (locks, queues, events) Synchronization primitives (locks, queues, events)
================================================== --------------------------------------------------
.. toctree:: .. toctree::
...@@ -33,20 +39,25 @@ Synchronization primitives (locks, queues, events) ...@@ -33,20 +39,25 @@ Synchronization primitives (locks, queues, events)
gevent.lock gevent.lock
Low-level details Low-level details
================= -----------------
.. toctree:: .. toctree::
gevent.hub gevent.hub
gevent.core gevent.core
.. _api_module_listing:
Module Listing Module Listing
============== ==============
This section of the document groups gevent APIs by module.
.. This should be sorted alphabetically .. This should be sorted alphabetically
.. toctree:: .. toctree::
gevent
gevent.backdoor gevent.backdoor
gevent.baseserver gevent.baseserver
gevent.builtins gevent.builtins
...@@ -82,7 +93,9 @@ Module Listing ...@@ -82,7 +93,9 @@ Module Listing
Deprecated Modules Deprecated Modules
================== ------------------
These modules are deprecated and should not be used in new code.
.. toctree:: .. toctree::
......
.. include:: ../CHANGES.rst .. include:: ../CHANGES.rst
Older Releases
==============
For full information on older versions, see :doc:`older_releases`.
.. toctree::
:caption: Older change logs, without context.
:maxdepth: 2
changelog_1_5
changelog_1_4
changelog_1_3
changelog_1_2
changelog_1_1
changelog_1_0
changelog_pre
...@@ -2,6 +2,8 @@ ...@@ -2,6 +2,8 @@
Table Of Contents Table Of Contents
=================== ===================
.. tip:: To jump directly to the full API reference, see :doc:`api/index`.
Introduction and Basics Introduction and Basics
======================= =======================
...@@ -9,8 +11,8 @@ Introduction and Basics ...@@ -9,8 +11,8 @@ Introduction and Basics
:maxdepth: 2 :maxdepth: 2
install install
changelog
intro intro
whatsnew_1_5
api/gevent api/gevent
api/gevent.greenlet api/gevent.greenlet
servers servers
...@@ -18,13 +20,13 @@ Introduction and Basics ...@@ -18,13 +20,13 @@ Introduction and Basics
monitoring monitoring
loop_impls loop_impls
configuration configuration
changelog
API Details
=========== Coding With gevent
==================
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 3
api/index api/index
......
...@@ -3,11 +3,24 @@ ...@@ -3,11 +3,24 @@
================================== ==================================
.. toctree:: .. toctree::
:caption: Release announcements
:maxdepth: 2 :maxdepth: 2
whatsnew_1_5
whatsnew_1_4 whatsnew_1_4
whatsnew_1_3 whatsnew_1_3
whatsnew_1_2 whatsnew_1_2
whatsnew_1_1 whatsnew_1_1
whatsnew_1_0 whatsnew_1_0
.. toctree::
:caption: Older change logs, without context.
:maxdepth: 2
changelog_1_5
changelog_1_4
changelog_1_3
changelog_1_2
changelog_1_1
changelog_1_0
changelog_pre changelog_pre
...@@ -10,7 +10,7 @@ ...@@ -10,7 +10,7 @@
changelog_1_3 changelog_1_3
Detailed information on what has changed is available in the Detailed information on what has changed is available in the
:doc:`changelog`. This document summarizes the most important changes :doc:`changelog_1_3`. This document summarizes the most important changes
since :doc:`gevent 1.2 <whatsnew_1_2>`. since :doc:`gevent 1.2 <whatsnew_1_2>`.
gevent 1.3 is an important update for performance, debugging and gevent 1.3 is an important update for performance, debugging and
......
...@@ -10,7 +10,7 @@ ...@@ -10,7 +10,7 @@
changelog_1_4 changelog_1_4
Detailed information on what has changed is available in the Detailed information on what has changed is available in the
:doc:`changelog`. This document summarizes the most important changes :doc:`changelog_1_4`. This document summarizes the most important changes
since :doc:`gevent 1.3 <whatsnew_1_3>`. since :doc:`gevent 1.3 <whatsnew_1_3>`.
gevent 1.4 is a small maintenance release featuring bug fixes and a gevent 1.4 is a small maintenance release featuring bug fixes and a
......
...@@ -10,7 +10,7 @@ ...@@ -10,7 +10,7 @@
changelog_1_5 changelog_1_5
Detailed information on what has changed is available in the Detailed information on what has changed is available in the
:doc:`changelog`. This document summarizes the most important changes :doc:`changelog_1_5`. This document summarizes the most important changes
since :doc:`gevent 1.4 <whatsnew_1_4>`. since :doc:`gevent 1.4 <whatsnew_1_4>`.
gevent 1.5 is a maintenance and feature release including bug fixes and a gevent 1.5 is a maintenance and feature release including bug fixes and a
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment