From 1ad9e0d0e3505200cc0d5e1dbb759f3315eaea20 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krist=C3=B3f=20T=C3=B3th?= Date: Tue, 31 Jul 2018 14:34:28 +0200 Subject: [PATCH] Add sphinx docs on rate limiting --- docs/source/index.rst | 10 ++++++++++ docs/source/utility/decorators.rst | 10 ++++++++++ 2 files changed, 20 insertions(+) create mode 100644 docs/source/utility/decorators.rst diff --git a/docs/source/index.rst b/docs/source/index.rst index 3d674ad..28b7a81 100644 --- 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 ================== diff --git a/docs/source/utility/decorators.rst b/docs/source/utility/decorators.rst new file mode 100644 index 0000000..0e16c23 --- /dev/null +++ b/docs/source/utility/decorators.rst @@ -0,0 +1,10 @@ +TFW decorators +-------------- + +.. automodule:: tfw.decorators.rate_limiter + +.. autoclass:: RateLimiter + :members: + +.. autoclass:: AsyncRateLimiter + :members: