summaryrefslogtreecommitdiff
path: root/docs/build/api.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/build/api.rst')
-rw-r--r--docs/build/api.rst18
1 files changed, 13 insertions, 5 deletions
diff --git a/docs/build/api.rst b/docs/build/api.rst
index 57c90d2..408bdde 100644
--- a/docs/build/api.rst
+++ b/docs/build/api.rst
@@ -2,22 +2,30 @@
API
===
-dogpile.core
-=============
+.. currentmodule:: dogpile.core
+
+Dogpile
+=======
+
+.. autoclass:: Dogpile
+ :members:
+
+.. autoclass:: SyncReaderDogpile
+ :members:
-.. automodule:: dogpile.core
+.. autoclass:: NeedRegenerationException
:members:
NameRegistry
=============
-.. automodule:: dogpile.core.nameregistry
+.. autoclass:: NameRegistry
:members:
Utilities
==========
-.. automodule:: dogpile.core.readwrite_lock
+.. autoclass:: ReadWriteMutex
:members: