[docs] Put S3 compat backends into their own section (#1376)

jschneier · Apr 21, 2024 · 68ef6ba · 68ef6ba
1 parent 5111199
commit 68ef6ba
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 4 deletions.
diff --git a/docs/backends/backblaze-B2.rst → docs/backends/s3_compatible/backblaze-B2.rst b/docs/backends/backblaze-B2.rst → docs/backends/s3_compatible/backblaze-B2.rst
diff --git a/docs/backends/digital-ocean-spaces.rst → ...ds/s3_compatible/digital-ocean-spaces.rst b/docs/backends/digital-ocean-spaces.rst → ...ds/s3_compatible/digital-ocean-spaces.rst
diff --git a/docs/backends/s3_compatible/index.rst b/docs/backends/s3_compatible/index.rst
@@ -0,0 +1,14 @@
+S3 Compatible
+=============
+
+Many service providers choose to implement the S3 protocol for their storage API.
+Below is a collection of documentation for how to configure the :doc:`Amazon S3 <../amazon-S3>`
+backend for some of the most popular.
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   backblaze-B2
+   digital-ocean-spaces
+   oracle-cloud
diff --git a/docs/backends/oracle-cloud.rst → docs/backends/s3_compatible/oracle-cloud.rst b/docs/backends/oracle-cloud.rst → docs/backends/s3_compatible/oracle-cloud.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -4,10 +4,17 @@ django-storages
 django-storages is a collection of custom storage backends for Django.
 
 .. toctree::
-   :maxdepth: 1
-   :glob:
-
-   backends/*
+   :maxdepth: 2
+   :titlesonly:
+
+   backends/amazon-S3
+   backends/apache_libcloud
+   backends/azure
+   backends/dropbox
+   backends/ftp
+   backends/gcloud
+   backends/sftp
+   backends/s3_compatible/index
 
 Installation
 ************