summaryrefslogtreecommitdiff
path: root/docs/reference.md
diff options
context:
space:
mode:
authorJordan Cook <jordan.cook@pioneer.com>2022-04-11 21:03:50 -0500
committerJordan Cook <jordan.cook@pioneer.com>2022-04-16 21:08:42 -0500
commitd6ee9143965d53dae44ca3a98802b2cc7ad6eeb7 (patch)
tree96e38c3f7289a0ff3a46c23df3f1e5b3b7c1a940 /docs/reference.md
parent166f5690fb8d5b067f839fa8ffb9421cf1b8a7e7 (diff)
downloadrequests-cache-d6ee9143965d53dae44ca3a98802b2cc7ad6eeb7.tar.gz
Move detailed backend docs from rst docstings to md files
Diffstat (limited to 'docs/reference.md')
-rw-r--r--docs/reference.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/reference.md b/docs/reference.md
index 9d784b9..bc74488 100644
--- a/docs/reference.md
+++ b/docs/reference.md
@@ -11,12 +11,17 @@ from requests_cache import CachedSession, RedisCache, json_serializer
```
:::
+<!--
+TODO:
+* move rst backend docs to md
+* Copy/overwrite from extra_modules/ to modules/
+-->
## Primary Modules
The following modules include the majority of the API relevant for most users:
```{toctree}
:maxdepth: 2
-session
+modules/requests_cache.session
modules/requests_cache.patcher
modules/requests_cache.backends
modules/requests_cache.models