diff options
| author | Jordan Cook <jordan.cook@pioneer.com> | 2021-08-19 17:07:08 -0500 |
|---|---|---|
| committer | Jordan Cook <jordan.cook@pioneer.com> | 2021-08-19 17:22:06 -0500 |
| commit | 41c0d433e217842a7c3aaa53f261e9a0ec313f01 (patch) | |
| tree | 3df6ac9978322cef7a8890ec53378757fcc9853e /docs/reference.md | |
| parent | 22243c1ff9b5081a6dc5dda4d7e18c9d3783d226 (diff) | |
| download | requests-cache-41c0d433e217842a7c3aaa53f261e9a0ec313f01.tar.gz | |
Put all links on main API Reference page into a single toctree, now that headings are less cluttered
Diffstat (limited to 'docs/reference.md')
| -rw-r--r-- | docs/reference.md | 45 |
1 files changed, 16 insertions, 29 deletions
diff --git a/docs/reference.md b/docs/reference.md index d25a50d..563843c 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -1,43 +1,30 @@ -% Note: backend and serializer module docs are auto-generated with apidoc; -% the remaining modules are manually added here for more custom formatting. +% Note: The module sources referenced here are auto-generated with apidoc (reference)= + # API Reference This section covers all the public interfaces of requests-cache. -## Sessions -% Explicitly show inherited method docs on CachedSession instead of CachedMixin -```{eval-rst} -.. autoclass:: requests_cache.session.CachedSession - :members: send, request, cache_disabled, remove_expired_responses - :show-inheritance: -``` - -```{eval-rst} -.. autoclass:: requests_cache.session.CacheMixin +:::{tip} +It's recommended to import from the top-level `requests_cache` package, as internal module paths +may be subject to change. For example: +```python +from requests_cache import CachedSession, RedisCache, json_serializer ``` +::: -## Patching -```{eval-rst} -.. automodule:: requests_cache.patcher - :members: -``` - -## Cache Backends ```{toctree} -modules/requests_cache.backends +:maxdepth: 1 +session +modules/requests_cache.patcher ``` - -## Models ```{toctree} +:maxdepth: 2 +modules/requests_cache.backends modules/requests_cache.models -``` - -## Serializers -```{toctree} modules/requests_cache.serializers ``` - -## Utilities ```{toctree} -utilities +:maxdepth: 1 +modules/requests_cache.cache_keys +modules/requests_cache.cache_control ``` |
