diff --git a/docs/source/api_reference.rst b/docs/source/api_reference.rst deleted file mode 100644 index 1b8636d4..00000000 --- a/docs/source/api_reference.rst +++ /dev/null @@ -1,117 +0,0 @@ -API reference -============= - -Subpackages ------------ - -.. toctree:: - - aredis.commands - -Submodules ----------- - -aredis\.cache module --------------------- - -.. automodule:: aredis.cache - :members: - :undoc-members: - :show-inheritance: - -aredis\.client module ---------------------- - -.. automodule:: aredis.client - :members: - :undoc-members: - :show-inheritance: - -aredis\.connection module -------------------------- - -.. automodule:: aredis.connection - :members: - :undoc-members: - :show-inheritance: - -aredis\.exceptions module -------------------------- - -.. automodule:: aredis.exceptions - :members: - :undoc-members: - :show-inheritance: - -aredis\.lock module -------------------- - -.. automodule:: aredis.lock - :members: - :undoc-members: - :show-inheritance: - -aredis\.nodemanager module --------------------------- - -.. automodule:: aredis.nodemanager - :members: - :undoc-members: - :show-inheritance: - -aredis\.pipeline module ------------------------ - -.. automodule:: aredis.pipeline - :members: - :undoc-members: - :show-inheritance: - -aredis\.pool module -------------------- - -.. automodule:: aredis.pool - :members: - :undoc-members: - :show-inheritance: - -aredis\.pubsub module ---------------------- - -.. automodule:: aredis.pubsub - :members: - :undoc-members: - :show-inheritance: - -aredis\.scripting module ------------------------- - -.. automodule:: aredis.scripting - :members: - :undoc-members: - :show-inheritance: - -aredis\.sentinel module ------------------------ - -.. automodule:: aredis.sentinel - :members: - :undoc-members: - :show-inheritance: - -aredis\.utils module --------------------- - -.. automodule:: aredis.utils - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: aredis - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/index.rst b/docs/source/index.rst index 4471f003..46d46cf0 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -135,6 +135,13 @@ Experimental: pypy 3.5-v5.8.0 is tesed and with it code can run twice faster than before. +API reference +------------- +Most API are described in `redis command reference`_ what makes difference and those should be noticed are referred in doc specially. +You can post a new issue / read redis command reference / read annotation of API (mainly about how to use them) if you have any problem about the API. +Related issue are welcome. + + The Usage Guide --------------- @@ -149,8 +156,6 @@ The Usage Guide scripting pipelines extra - api_reference - The Community Guide -------------------