diff options
| author | Jordan Cook <jordan.cook@pioneer.com> | 2022-03-19 21:50:54 -0500 |
|---|---|---|
| committer | Jordan Cook <jordan.cook@pioneer.com> | 2022-04-01 13:48:25 -0500 |
| commit | 550fca5c604fa9635b19bb4ba10d444e36b30d05 (patch) | |
| tree | 9a6882a7765db1e4201614d171bd3814ef39b39b /docs/reference.md | |
| parent | 5a9a18c7bd1d14812fe6308992a193d4a1479a1e (diff) | |
| download | requests-cache-550fca5c604fa9635b19bb4ba10d444e36b30d05.tar.gz | |
Update docs, doc dependencies, changelog, and contributors
Also:
Restrict redis-py to <4.2, which breaks parameter forwarding on python 3.7 and 3.8
Diffstat (limited to 'docs/reference.md')
| -rw-r--r-- | docs/reference.md | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/docs/reference.md b/docs/reference.md index f5a1b8a..9d784b9 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -11,19 +11,24 @@ from requests_cache import CachedSession, RedisCache, json_serializer ``` ::: +## Primary Modules +The following modules include the majority of the API relevant for most users: + ```{toctree} -:maxdepth: 1 +:maxdepth: 2 session modules/requests_cache.patcher -``` -```{toctree} -:maxdepth: 2 modules/requests_cache.backends modules/requests_cache.models -modules/requests_cache.serializers +modules/requests_cache.settings ``` + +## Secondary Modules +The following modules are mainly for internal use, and are relevant for contributors and advanced users: ```{toctree} -:maxdepth: 1 +:maxdepth: 2 modules/requests_cache.cache_keys modules/requests_cache.cache_control +modules/requests_cache.expiration +modules/requests_cache.serializers ``` |