summaryrefslogtreecommitdiff
path: root/docs/api/requests_cache.backends.gridfs.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/api/requests_cache.backends.gridfs.md
parent166f5690fb8d5b067f839fa8ffb9421cf1b8a7e7 (diff)
downloadrequests-cache-d6ee9143965d53dae44ca3a98802b2cc7ad6eeb7.tar.gz
Move detailed backend docs from rst docstings to md files
Diffstat (limited to 'docs/api/requests_cache.backends.gridfs.md')
-rw-r--r--docs/api/requests_cache.backends.gridfs.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/api/requests_cache.backends.gridfs.md b/docs/api/requests_cache.backends.gridfs.md
new file mode 100644
index 0000000..18a2583
--- /dev/null
+++ b/docs/api/requests_cache.backends.gridfs.md
@@ -0,0 +1,23 @@
+# GridFS
+```{image} ../_static/mongodb.png
+```
+
+[GridFS](https://docs.mongodb.com/manual/core/gridfs/) is a specification for storing large files
+in MongoDB.
+
+## Use Cases
+Use this backend if you are using MongoDB and expect to store responses **larger than 16MB**. See
+{py:mod}`~requests_cache.backends.mongodb` for more general info.
+
+## API Reference
+```{eval-rst}
+.. automodsumm:: requests_cache.backends.gridfs
+ :classes-only:
+ :nosignatures:
+
+.. automodule:: requests_cache.backends.gridfs
+ :members:
+ :undoc-members:
+ :inherited-members:
+ :show-inheritance:
+```