You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@libcloud.apache.org by to...@apache.org on 2023/08/08 19:49:55 UTC
[libcloud] branch trunk updated (e47a200da -> 794818cd1)
This is an automated email from the ASF dual-hosted git repository.
tomaz pushed a change to branch trunk
in repository https://gitbox.apache.org/repos/asf/libcloud.git
from e47a200da Remove rtd requirements to see if it fixes the issue with bullet points not rendering on RTD when using newer version of sphinx.
new 4ac1e16e0 Add a comment on why we need to use older sphinx version on RTD, fix some syntax issues in the docs.
new 794818cd1 Remove libcloud.utils.dist module which is unused now that we have switched from setup.py to pyproject.toml.
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.readthedocs.yml | 2 +
docs/other/changes_in_2_0.rst | 2 +
docs/storage/drivers/scaleway.rst | 4 +-
libcloud/utils/dist.py | 136 --------------------------------------
4 files changed, 6 insertions(+), 138 deletions(-)
delete mode 100644 libcloud/utils/dist.py
[libcloud] 01/02: Add a comment on why we need to use older sphinx version on RTD, fix some syntax issues in the docs.
Posted by to...@apache.org.
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.
[libcloud] 02/02: Remove libcloud.utils.dist module which is unused now that we have switched from setup.py to pyproject.toml.
Posted by to...@apache.org.
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 794818cd163189104e66fad54be0359b29fc6097
Author: Tomaz Muraus <to...@tomaz.me>
AuthorDate: Tue Aug 8 21:45:30 2023 +0200
Remove libcloud.utils.dist module which is unused now that we have
switched from setup.py to pyproject.toml.
---
libcloud/utils/dist.py | 136 -------------------------------------------------
1 file changed, 136 deletions(-)
diff --git a/libcloud/utils/dist.py b/libcloud/utils/dist.py
deleted file mode 100644
index 12001375b..000000000
--- a/libcloud/utils/dist.py
+++ /dev/null
@@ -1,136 +0,0 @@
-# Licensed to the Apache Software Foundation (ASF) under one or more
-# contributor license agreements. See the NOTICE file distributed with
-# this work for additional information regarding copyright ownership.
-# The ASF licenses this file to You under the Apache License, Version 2.0
-# (the "License"); you may not use this file except in compliance with
-# the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Taken From Twisted Python which licensed under MIT license
-# https://github.com/powdahound/twisted/blob/master/twisted/python/dist.py
-# https://github.com/powdahound/twisted/blob/master/LICENSE
-
-import os
-import fnmatch
-
-# Names that are excluded from globbing results:
-EXCLUDE_NAMES = ["{arch}", "CVS", ".cvsignore", "_darcs", "RCS", "SCCS", ".svn"]
-EXCLUDE_PATTERNS = ["*.py[cdo]", "*.s[ol]", ".#*", "*~", "*.py"]
-
-
-def _filter_names(names):
- """
- Given a list of file names, return those names that should be copied.
- """
- names = [n for n in names if n not in EXCLUDE_NAMES]
- # This is needed when building a distro from a working
- # copy (likely a checkout) rather than a pristine export:
- for pattern in EXCLUDE_PATTERNS:
- names = [n for n in names if not fnmatch.fnmatch(n, pattern) and not n.endswith(".py")]
- return names
-
-
-def relative_to(base, relativee):
- """
- Gets 'relativee' relative to 'basepath'.
-
- i.e.,
-
- >>> relative_to('/home/', '/home/radix/')
- 'radix'
- >>> relative_to('.', '/home/radix/Projects/Twisted')
- 'Projects/Twisted'
-
- The 'relativee' must be a child of 'basepath'.
- """
- basepath = os.path.abspath(base)
- relativee = os.path.abspath(relativee)
- if relativee.startswith(basepath):
- relative = relativee[len(basepath) :]
- if relative.startswith(os.sep):
- relative = relative[1:]
- return os.path.join(base, relative)
- raise ValueError("{} is not a subpath of {}".format(relativee, basepath))
-
-
-def get_packages(dname, pkgname=None, results=None, ignore=None, parent=None):
- """
- Get all packages which are under dname. This is necessary for
- Python 2.2's distutils. Pretty similar arguments to getDataFiles,
- including 'parent'.
- """
- parent = parent or ""
- prefix = []
- if parent:
- prefix = [parent]
- bname = os.path.basename(dname)
- ignore = ignore or []
- if bname in ignore:
- return []
- if results is None:
- results = []
- if pkgname is None:
- pkgname = []
- subfiles = os.listdir(dname)
- abssubfiles = [os.path.join(dname, x) for x in subfiles]
-
- if "__init__.py" in subfiles:
- results.append(prefix + pkgname + [bname])
- for subdir in filter(os.path.isdir, abssubfiles):
- get_packages(
- subdir,
- pkgname=pkgname + [bname],
- results=results,
- ignore=ignore,
- parent=parent,
- )
- res = [".".join(result) for result in results]
- return res
-
-
-def get_data_files(dname, ignore=None, parent=None):
- """
- Get all the data files that should be included in this distutils Project.
-
- 'dname' should be the path to the package that you're distributing.
-
- 'ignore' is a list of sub-packages to ignore. This facilitates
- disparate package hierarchies. That's a fancy way of saying that
- the 'twisted' package doesn't want to include the 'twisted.conch'
- package, so it will pass ['conch'] as the value.
-
- 'parent' is necessary if you're distributing a subpackage like
- twisted.conch. 'dname' should point to 'twisted/conch' and 'parent'
- should point to 'twisted'. This ensures that your data_files are
- generated correctly, only using relative paths for the first element
- of the tuple ('twisted/conch/*').
- The default 'parent' is the current working directory.
- """
- parent = parent or "."
- ignore = ignore or []
- result = []
- for directory, subdirectories, filenames in os.walk(dname):
- resultfiles = []
- for exname in EXCLUDE_NAMES:
- if exname in subdirectories:
- subdirectories.remove(exname)
- for ig in ignore:
- if ig in subdirectories:
- subdirectories.remove(ig)
- for filename in _filter_names(filenames):
- resultfiles.append(filename)
- if resultfiles:
- for filename in resultfiles:
- file_path = os.path.join(directory, filename)
- if parent:
- file_path = file_path.replace(parent + os.sep, "")
- result.append(file_path)
-
- return result