This is an automated email from the ASF dual-hosted git repository.
tomaz pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/libcloud.git
commit 4ac1e16e09ba5fab4fafb3bd5b438eac3a8fe6eb
Author: Tomaz Muraus <to...@tomaz.me>
AuthorDate: Tue Aug 8 21:33:21 2023 +0200
Add a comment on why we need to use older sphinx version on RTD, fix
some syntax issues in the docs.
---
.readthedocs.yml | 2 ++
docs/other/changes_in_2_0.rst | 2 ++
docs/storage/drivers/scaleway.rst | 4 ++--
3 files changed, 6 insertions(+), 2 deletions(-)
diff --git a/.readthedocs.yml b/.readthedocs.yml
index 0a8b84010..97531b13f 100644
--- a/.readthedocs.yml
+++ b/.readthedocs.yml
@@ -18,6 +18,8 @@ formats:
- pdf
- epub
+# NOTE: We need to use older version of sphinx otherwise bullet points won't
be rendered correctly
+# on RTD using rtd theme.
# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
diff --git a/docs/other/changes_in_2_0.rst b/docs/other/changes_in_2_0.rst
index 706db12e3..0c127dbe6 100644
--- a/docs/other/changes_in_2_0.rst
+++ b/docs/other/changes_in_2_0.rst
@@ -1,3 +1,5 @@
+:orphan:
+
Changes in Apache Libcloud v2.0
===============================
diff --git a/docs/storage/drivers/scaleway.rst
b/docs/storage/drivers/scaleway.rst
index 20ea6503e..3d4a511ee 100644
--- a/docs/storage/drivers/scaleway.rst
+++ b/docs/storage/drivers/scaleway.rst
@@ -1,5 +1,5 @@
Scaleway Storage Driver Documentation
-==================================
+=====================================
Scaleway Object Storage is an Object Storage service based on the S3 protocol.
@@ -15,7 +15,7 @@ Examples
--------
1. Upload a file to Scaleway's Object Storage
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This example shows how to upload a local file to Scaleway's Object Storage.
