diff options
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 84 |
1 files changed, 55 insertions, 29 deletions
diff --git a/docs/index.rst b/docs/index.rst index 18c2e69..8e243f3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,45 +6,71 @@ Welcome to redis-py's documentation! ==================================== -Indices and tables ------------------- +Getting Started +**************** -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` +`redis-py <https://pypi.org/project/redis>`_ requires a running Redis server, and Python 3.6+. See the `Redis +quickstart <https://redis.io/topics/quickstart>`_ for Redis installation instructions. -Contents: ---------- +redis-py can be installed using pip via ``pip install redis``. -.. toctree:: - :maxdepth: 2 -.. automodule:: redis - :members: +Quickly connecting to redis +************ + +There are two quick ways to connect to Redis. + +Assuming you run Redis on localhost:6379 (the default):: + import redis + r = redis.Redis() + r.ping() + +Running redis on foo.bar.com, port 12345:: + import redis + r = redis.Redis(host='foo.bar.com', port=12345) + r.ping() + +Another example with foo.bar.com, port 12345:: + import redis + r = redis.from_url('redis://foo.bar.com:12345') + r.ping() -.. automodule:: redis.backoff - :members: +After that, you probably want to `run redis commands <redis_core_commands.html>`_. -.. automodule:: redis.connection - :members: +.. toctree:: + :hidden: + + genindex + +Redis Command Functions +*********************** +.. toctree:: + :maxdepth: 2 -.. automodule:: redis.commands - :members: + redis_core_commands + sentinel_commands + redismodules -.. automodule:: redis.commands.json - :members: +Module Documentation +******************** +.. toctree:: + :maxdepth: 1 -.. automodule:: redis.commands.search - :members: + backoff + connections + exceptions + lock + retry -.. automodule:: redis.commands.timeseries - :members: +Contributing +************* -.. automodule:: redis.exceptions - :members: +- `How to contribute <https://github.com/redis/redis-py/blob/master/CONTRIBUTING.md>`_ +- `Issue Tracker <https://github.com/redis/redis-py/issues>`_ +- `Source Code <https://github.com/redis/redis-py/>`_ +- `Release History <https://github.com/redis/redis-py/releases/>`_ -.. automodule:: redis.lock - :members: +License +******* -.. automodule:: redis.sentinel - :members: +This projectis licensed under the `MIT license <https://github.com/redis/redis-py/blob/master/LICENSE>`_. |