Add sphinx docs on rate limiting

2018-07-31 14:34:28 +02:00 · 2018-07-31 14:34:28 +02:00 · 1ad9e0d0e3
parent b6d72812c4
commit 1ad9e0d0e3
2 changed files with 20 additions and 0 deletions
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@ -36,6 +36,16 @@ These are pre-written components for you to use, such as our IDE, terminal or co

    components/*

+Utility
+-------
+
+These are useful decorators, mixins and helpers to make common dev tasks easier.
+
+.. toctree::
+    :glob:
+
+    utility/*
+

 Indices and tables
 ==================
--- a/docs/source/utility/decorators.rst
+++ b/docs/source/utility/decorators.rst
@ -0,0 +1,10 @@
+TFW decorators
+--------------
+
+.. automodule:: tfw.decorators.rate_limiter
+
+.. autoclass:: RateLimiter
+    :members:
+
+.. autoclass:: AsyncRateLimiter
+    :members: