summaryrefslogtreecommitdiffstats
path: root/tools/moztreedocs/package.py
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
commit36d22d82aa202bb199967e9512281e9a53db42c9 (patch)
tree105e8c98ddea1c1e4784a60a5a6410fa416be2de /tools/moztreedocs/package.py
parentInitial commit. (diff)
downloadfirefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.tar.xz
firefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.zip
Adding upstream version 115.7.0esr.upstream/115.7.0esrupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'tools/moztreedocs/package.py')
-rw-r--r--tools/moztreedocs/package.py29
1 files changed, 29 insertions, 0 deletions
diff --git a/tools/moztreedocs/package.py b/tools/moztreedocs/package.py
new file mode 100644
index 0000000000..b8db23ee87
--- /dev/null
+++ b/tools/moztreedocs/package.py
@@ -0,0 +1,29 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, # You can obtain one at http://mozilla.org/MPL/2.0/.
+
+import os
+
+from mozpack.archive import create_tar_gz_from_files
+from mozpack.files import FileFinder
+
+
+def distribution_files(root):
+ """Find all files suitable for distributing.
+
+ Given the path to generated Sphinx documentation, returns an iterable
+ of (path, BaseFile) for files that should be archived, uploaded, etc.
+ Paths are relative to given root directory.
+ """
+ finder = FileFinder(root, ignore=("_staging", "_venv"))
+ return finder.find("**")
+
+
+def create_tarball(filename, root):
+ """Create a tar.gz archive of docs in a directory."""
+ files = dict(distribution_files(root))
+
+ with open(filename, "wb") as fh:
+ create_tar_gz_from_files(
+ fh, files, filename=os.path.basename(filename), compresslevel=6
+ )