From c877efb7ec78c0be688ccc8655d509c422ef659b Mon Sep 17 00:00:00 2001
From: Alistair Coles <alistairncoles@gmail.com>
Date: Fri, 25 Oct 2024 12:16:19 +0100
Subject: [PATCH] docs: add new utils modules to source doc

Some submodules have previously been broken out of the utils
module. This patch adds automodule directives for the new modules to
the source documentation.

Change-Id: I985205fda95f01d226e81dcbfe0d6dbbb5b69c96
Related-Change:  Ic4b5005e3efffa8dba17d91a41e46d5c68533f9a
---
 doc/source/misc.rst | 82 ++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 73 insertions(+), 9 deletions(-)

diff --git a/doc/source/misc.rst b/doc/source/misc.rst
index 4d4b3dcda6..1012b13bec 100644
--- a/doc/source/misc.rst
+++ b/doc/source/misc.rst
@@ -22,6 +22,16 @@ Buffered HTTP
     :members:
     :show-inheritance:
 
+
+.. _config:
+
+Config
+======
+
+.. automodule:: swift.common.utils.config
+    :members:
+    :show-inheritance:
+
 .. _constraints:
 
 Constraints
@@ -80,6 +90,33 @@ Internal Client
     :undoc-members:
     :show-inheritance:
 
+.. _ipaddrs:
+
+IPAddrs
+=======
+
+.. automodule:: swift.common.utils.ipaddrs
+    :members:
+    :show-inheritance:
+
+.. _libc:
+
+Libc
+====
+
+.. automodule:: swift.common.utils.libc
+    :members:
+    :show-inheritance:
+
+.. _logs:
+
+Logs
+====
+
+.. automodule:: swift.common.utils.logs
+    :members:
+    :show-inheritance:
+
 Manager
 =========
 
@@ -114,6 +151,24 @@ Request Helpers
     :undoc-members:
     :show-inheritance:
 
+.. _statsd_client:
+
+StatsdClient
+============
+
+.. automodule:: swift.common.statsd_client
+    :members:
+    :show-inheritance:
+
+.. _storage_policy:
+
+Storage Policy
+==============
+
+.. automodule:: swift.common.storage_policy
+    :members:
+    :show-inheritance:
+
 .. _swob:
 
 Swob
@@ -124,6 +179,24 @@ Swob
     :show-inheritance:
     :special-members: __call__
 
+.. _timestamp:
+
+Timestamp
+=========
+
+.. automodule:: swift.common.utils.timestamp
+    :members:
+    :show-inheritance:
+
+.. _base_utils:
+
+Utils Base
+==========
+
+.. automodule:: swift.common.utils.base
+    :members:
+    :show-inheritance:
+
 .. _utils:
 
 Utils
@@ -141,12 +214,3 @@ WSGI
 .. automodule:: swift.common.wsgi
     :members:
     :show-inheritance:
-
-.. _storage_policy:
-
-Storage Policy
-==============
-
-.. automodule:: swift.common.storage_policy
-    :members:
-    :show-inheritance: