diff options
| author | Roman <reclosedev@gmail.com> | 2012-04-08 21:42:42 +0400 |
|---|---|---|
| committer | Roman <reclosedev@gmail.com> | 2012-04-08 21:42:42 +0400 |
| commit | ec944326f7699d12a5d5979822fa20d5e85226b9 (patch) | |
| tree | d3d742459d522497a73b233f6ed412ba429285c6 /docs | |
| parent | ea071fb2eec02a8ed32183a1da59cb7e026c891a (diff) | |
| download | requests-cache-ec944326f7699d12a5d5979822fa20d5e85226b9.tar.gz | |
MemoryCache now reduces and Response. More docstrings
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api.rst | 18 | ||||
| -rw-r--r-- | docs/conf.py | 3 | ||||
| -rw-r--r-- | docs/index.rst | 2 |
3 files changed, 23 insertions, 0 deletions
diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 0000000..7cdad8d --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,18 @@ +API +=== + +This part of the documentation covers all the interfaces of :mod:`requsts_cache` + + +Public api +---------- + +.. automodule:: requests_cache.core + :members: + + +Extensible objects +------------------ + +.. automodule:: requests_cache.backends.base + :members: diff --git a/docs/conf.py b/docs/conf.py index ffacd5c..f6c5bc7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -240,3 +240,6 @@ texinfo_documents = [ # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' + +autoclass_content = 'both' +autodoc_member_order = 'bysource'
\ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index ac756f5..e15e587 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,6 +11,8 @@ Contents: .. toctree:: :maxdepth: 2 + api + Indices and tables |