[tor-commits] [stem/master] Adding stub for API page

[atagar at torproject.org]

commit f996e24b794c0f96e8e8221cdde5f21d8c2cf900
Author: Damian Johnson <atagar at torproject.org>
Date:   Mon Oct 15 09:13:58 2012 -0700

    Adding stub for API page
    
    Moving the old API docs to its own page. It's presently pretty minimal and
    sucky, but at least moving it to the right spot for now.
---
 docs/_static/buttons/api.png                |  Bin 0 -> 11189 bytes
 docs/_static/buttons/resources/api.xcf      |  Bin 0 -> 30814 bytes
 docs/_static/buttons/resources/tutorial.xcf |  Bin 32568 -> 36318 bytes
 docs/_static/buttons/tutorial.png           |  Bin 12908 -> 14530 bytes
 docs/api.rst                                |   46 +++++++++++++++++++++++++
 docs/index.rst                              |   48 +++------------------------
 6 files changed, 51 insertions(+), 43 deletions(-)

diff --git a/docs/_static/buttons/api.png b/docs/_static/buttons/api.png
new file mode 100644
index 0000000..5390376
Binary files /dev/null and b/docs/_static/buttons/api.png differ
diff --git a/docs/_static/buttons/resources/api.xcf b/docs/_static/buttons/resources/api.xcf
new file mode 100644
index 0000000..1fd067d
Binary files /dev/null and b/docs/_static/buttons/resources/api.xcf differ
diff --git a/docs/_static/buttons/resources/tutorial.xcf b/docs/_static/buttons/resources/tutorial.xcf
index 5e9afed..00246cd 100644
Binary files a/docs/_static/buttons/resources/tutorial.xcf and b/docs/_static/buttons/resources/tutorial.xcf differ
diff --git a/docs/_static/buttons/tutorial.png b/docs/_static/buttons/tutorial.png
index 65e0f38..039f5a2 100644
Binary files a/docs/_static/buttons/tutorial.png and b/docs/_static/buttons/tutorial.png differ
diff --git a/docs/api.rst b/docs/api.rst
new file mode 100644
index 0000000..0e71afa
--- /dev/null
+++ b/docs/api.rst
@@ -0,0 +1,46 @@
+API
+===
+
+:mod:`stem.connection`
+----------------------
+
+Connecting and authenticating to a Tor process.
+
+:mod:`stem.control`
+-------------------
+
+Provides the :class:`~stem.control.Controller` class which, as the name implies, is used for talking with and controlling a Tor instance. As a user this is the primary class that you'll need.
+
+:mod:`stem.socket`
+------------------
+
+Base classes for communicating with a Tor control socket.
+
+:mod:`stem.process`
+-------------------
+
+Used for launching Tor and managing the process.
+
+:mod:`stem.version`
+-------------------
+
+Parsed versions that can be compared to the requirement for various features.
+
+`stem.descriptor <stem.descriptor.html>`_
+-----------------------------------------
+
+Utilities for working with the Tor consensus and descriptors.
+
+`stem.response <stem.response.html>`_
+-------------------------------------
+
+Parsed replies that we receive from the Tor control socket.
+
+`stem.util <stem.util.html>`_
+-----------------------------
+
+Utility functions available to stem and its users.
+
+.. toctree::
+   :maxdepth: 2
+
diff --git a/docs/index.rst b/docs/index.rst
index 69c01b2..95c1589 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -6,52 +6,12 @@ Stem is a python controller library for `Tor <https://www.torproject.org/>`_. Li
 .. image:: /_static/buttons/tutorial.png
    :target: tutorial.html
 
+.. image:: /_static/buttons/api.png
+   :target: api.html
+
 .. image:: /_static/buttons/download.png
    :target: download.html
 
-:mod:`stem.connection`
-----------------------
-
-Connecting and authenticating to a Tor process.
-
-:mod:`stem.control`
-----------------------
-
-Provides the :class:`~stem.control.Controller` class which, as the name implies, is used for talking with and controlling a Tor instance. As a user this is the primary class that you'll need.
-
-:mod:`stem.socket`
-------------------
-
-Base classes for communicating with a Tor control socket.
-
-:mod:`stem.process`
--------------------
-
-Used for launching Tor and managing the process.
-
-:mod:`stem.version`
--------------------
-
-Parsed versions that can be compared to the requirement for various features.
-
-`stem.descriptor <stem.descriptor.html>`_
--------------------------------------
-
-Utilities for working with the Tor consensus and descriptors.
-
-`stem.response <stem.response.html>`_
--------------------------------------
-
-Parsed replies that we receive from the Tor control socket.
-
-`stem.util <stem.util.html>`_
------------------------------
-
-Utility functions available to stem and its users.
-
-.. toctree::
-   :maxdepth: 2
-
 Indices and tables
 ==================
 
@@ -63,3 +23,5 @@ Indices and tables
 
 
 
+
+