Permalink
Browse files

Try my hand at the Sphinx documentation.

  • Loading branch information...
1 parent 3565e56 commit 373907d2afbcac42fea238aaf9ddba7fa4215172 Adam Lindsay committed Apr 30, 2010
Showing with 19 additions and 12 deletions.
  1. +1 −0 docs/index.rst
  2. +5 −9 README-proxy.rst → docs/proxy.rst
  3. +1 −0 docs/reference/index.rst
  4. +8 −0 docs/reference/redish.proxy.rst
  5. +4 −3 redish/proxy.py
View
@@ -7,6 +7,7 @@ Contents:
:maxdepth: 3
introduction
+ proxy
reference/index
changelog
View
@@ -1,14 +1,10 @@
-============================================================================
-redish - Pythonic Redis abstraction built on top of redis-py
-============================================================================
-
-Proxy
-=====
+Accessing Redis via the Proxy object
+====================================
By mixing the type system from redish with the original redis-py's Redis
-object, the redish.proxy module gives a different sort of transparent access
-to the key-value store without pickling/unpickling and by respecting the
-strengths in Redis's types. In other words, it respects Redis as a data
+object, the :doc:`reference/redish.proxy` module gives a different kind of access to the
+key-value store without pickling/unpickling and by respecting the strengths in
+Redis's types. In other words, it transparently exposes Redis as a data
structure server.
Basics
View
@@ -11,6 +11,7 @@
redish.client
redish.types
redish.models
+ redish.proxy
redish.serialization
redish.utils
@@ -0,0 +1,8 @@
+==========================
+ redish.proxy
+==========================
+
+.. currentmodule:: redish.proxy
+
+.. automodule:: redish.proxy
+ :members:
View
@@ -1,7 +1,7 @@
"""
-proxy.py
-
-Created by Adam T. Lindsay on 2010-04-28.
+.. module:: proxy.py
+ :synopsis: Transparent access to Redis as a data structure server
+.. moduleauthor:: Adam T. Lindsay <http://github.com/atl>
Rather than use the native redis-py's methods for getitem/setitem as simple
key-value storage, use item access as a means to obtain proxy objects for
@@ -11,6 +11,7 @@
This provides as simple access as possible to redis as a "data structure"
server.
+(originally by Adam T. Lindsay)
"""
from codecs import encode, decode
from redis import Redis

0 comments on commit 373907d

Please sign in to comment.