From 68ef6ba91465ceb950daf10923a1755ea539d8be Mon Sep 17 00:00:00 2001 From: Josh Schneier Date: Sat, 20 Apr 2024 22:03:22 -0400 Subject: [PATCH] [docs] Put S3 compat backends into their own section (#1376) --- .../backends/{ => s3_compatible}/backblaze-B2.rst | 0 .../{ => s3_compatible}/digital-ocean-spaces.rst | 0 docs/backends/s3_compatible/index.rst | 14 ++++++++++++++ .../backends/{ => s3_compatible}/oracle-cloud.rst | 0 docs/index.rst | 15 +++++++++++---- 5 files changed, 25 insertions(+), 4 deletions(-) rename docs/backends/{ => s3_compatible}/backblaze-B2.rst (100%) rename docs/backends/{ => s3_compatible}/digital-ocean-spaces.rst (100%) create mode 100644 docs/backends/s3_compatible/index.rst rename docs/backends/{ => s3_compatible}/oracle-cloud.rst (100%) diff --git a/docs/backends/backblaze-B2.rst b/docs/backends/s3_compatible/backblaze-B2.rst similarity index 100% rename from docs/backends/backblaze-B2.rst rename to docs/backends/s3_compatible/backblaze-B2.rst diff --git a/docs/backends/digital-ocean-spaces.rst b/docs/backends/s3_compatible/digital-ocean-spaces.rst similarity index 100% rename from docs/backends/digital-ocean-spaces.rst rename to docs/backends/s3_compatible/digital-ocean-spaces.rst diff --git a/docs/backends/s3_compatible/index.rst b/docs/backends/s3_compatible/index.rst new file mode 100644 index 000000000..bb19b1874 --- /dev/null +++ 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 b/docs/backends/s3_compatible/oracle-cloud.rst similarity index 100% rename from docs/backends/oracle-cloud.rst rename to docs/backends/s3_compatible/oracle-cloud.rst diff --git a/docs/index.rst b/docs/index.rst index c432233de..2bc28b687 100644 --- 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 ************