[tor-commits] [stem/master] Adding basic stem intro to sphinx index

atagar at torproject.org atagar at torproject.org
Wed Jun 6 04:30:17 UTC 2012


commit af83350dcf62f819d8e84c6e34051dc3ff509add
Author: Damian Johnson <atagar at torproject.org>
Date:   Sat Jun 2 13:35:12 2012 -0700

    Adding basic stem intro to sphinx index
---
 docs/index.rst   |    6 ++++--
 stem/__init__.py |    2 --
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/docs/index.rst b/docs/index.rst
index 8434a81..3141b2e 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -3,8 +3,10 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to Stem's documentation!
-================================
+Welcome to Stem!
+================
+
+Stem is a python controller library for `Tor <https://www.torproject.org/>`_. Like its predecessor, `TorCtl <https://www.torproject.org/getinvolved/volunteer.html.en#project-torctl>`_, it uses Tor's `control protocol <https://gitweb.torproject.org/torspec.git/blob/HEAD:/control-spec.txt>`_ to help developers program against the Tor process, enabling them to build things similar to `Vidalia <https://www.torproject.org/getinvolved/volunteer.html.en#project-vidalia>`_ and `arm <http://www.atagar.com/arm/>`_.
 
 Contents:
 
diff --git a/stem/__init__.py b/stem/__init__.py
index 152a7df..61374a6 100644
--- a/stem/__init__.py
+++ b/stem/__init__.py
@@ -10,5 +10,3 @@ __license__ = 'LGPLv3'
 
 __all__ = ["descriptor", "response", "util", "connection", "control", "process", "socket", "version"]
 
-
-





More information about the tor-commits mailing list