swift/doc/source/audit_watchers.rst
Matthew Oliver 46a6a09d5b Create a separate doc for audit watcher
We have a separate doc page for middlewares that pulls the docstring
from each middleware's docstring[0]. This makes it easy to look up the docs
in our documentation and easy to find the middleware doc by looking in
the code of the middleware itself.

This patch does the same with the audit watchers. There is now a page
that generates a list of audit watchers, even though currently it's only
one, and pulls the docs from their docstrings. Giving us an easy way to
maintain each audit watcher doc along with it's code.

[0] - https://docs.openstack.org/swift/latest/middleware.html

Change-Id: I1456aba0158d29fa0a879dcc2dfb13245c45ad16
2021-01-06 17:38:45 +00:00

177 B

Object Audit Watchers

Dark Data

swift.obj.watchers.dark_data