gh-132983: Add documentation for compression.zstd (GH-133911)

emmatyping · AA-Turner · StanFromIreland · web-flow · commit d862b6de1bcf · 2025-05-21T07:18:21.000-07:00
Add documentation for compression &amp; compression.zstd.

🎉

---------

Co-authored-by: Adam Turner &lt;9087854+AA-Turner@users.noreply.github.com&gt;
Co-authored-by: Stan Ulbrych &lt;89152624+StanFromIreland@users.noreply.github.com&gt;
Co-authored-by: Hugo van Kemenade &lt;1324225+hugovk@users.noreply.github.com&gt;
Co-authored-by: Sumana Harihareswara &lt;sh@changeset.nyc&gt;
Co-authored-by: Martin Panter &lt;vadmium@users.noreply.github.com&gt;
diff --git a/Doc/library/archiving.rst b/Doc/library/archiving.rst
@@ -5,13 +5,15 @@ Data Compression and Archiving
 ******************************
 
 The modules described in this chapter support data compression with the zlib,
-gzip, bzip2 and lzma algorithms, and the creation of ZIP- and tar-format
+gzip, bzip2, lzma, and zstd algorithms, and the creation of ZIP- and tar-format
 archives.  See also :ref:`archiving-operations` provided by the :mod:`shutil`
 module.
 
 
 .. toctree::
 
+   compression.rst
+   compression.zstd.rst
    zlib.rst
    gzip.rst
    bz2.rst
diff --git a/Doc/library/compression.rst b/Doc/library/compression.rst
@@ -0,0 +1,18 @@
+The :mod:`!compression` package
+===============================
+
+.. versionadded:: 3.14
+
+The :mod:`!compression` package contains the canonical compression modules
+containing interfaces to several different compression algorithms. Some of
+these modules have historically been available as separate modules; those will
+continue to be available under their original names for compatibility reasons,
+and will not be removed without a deprecation cycle. The use of modules in
+:mod:`!compression` is encouraged where practical.
+
+* :mod:`!compression.bz2` -- Re-exports :mod:`bz2`
+* :mod:`!compression.gzip` -- Re-exports :mod:`gzip`
+* :mod:`!compression.lzma` -- Re-exports :mod:`lzma`
+* :mod:`!compression.zlib` -- Re-exports :mod:`zlib`
+* :mod:`compression.zstd` -- Wrapper for the Zstandard compression library
+
diff --git a/Doc/library/compression.zstd.rst b/Doc/library/compression.zstd.rst
