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
This commit is contained in:
Alistair Coles 2024-10-25 12:16:19 +01:00
parent 288677695d
commit c877efb7ec

View File

@ -22,6 +22,16 @@ Buffered HTTP
:members: :members:
:show-inheritance: :show-inheritance:
.. _config:
Config
======
.. automodule:: swift.common.utils.config
:members:
:show-inheritance:
.. _constraints: .. _constraints:
Constraints Constraints
@ -80,6 +90,33 @@ Internal Client
:undoc-members: :undoc-members:
:show-inheritance: :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 Manager
========= =========
@ -114,6 +151,24 @@ Request Helpers
:undoc-members: :undoc-members:
:show-inheritance: :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:
Swob Swob
@ -124,6 +179,24 @@ Swob
:show-inheritance: :show-inheritance:
:special-members: __call__ :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:
Utils Utils
@ -141,12 +214,3 @@ WSGI
.. automodule:: swift.common.wsgi .. automodule:: swift.common.wsgi
:members: :members:
:show-inheritance: :show-inheritance:
.. _storage_policy:
Storage Policy
==============
.. automodule:: swift.common.storage_policy
:members:
:show-inheritance: