aboutsummaryrefslogtreecommitdiffstats
path: root/docs/policies.rst
diff options
context:
space:
mode:
authorAdam Stokes <adam.stokes@ubuntu.com>2014-08-07 16:23:38 +0200
committerBryn M. Reeves <bmr@redhat.com>2014-08-07 17:50:14 +0100
commit217358a297664a8fb8419ef8fa21499f88d7eb85 (patch)
treebef01e2477204fbb5dc673d3c23f6d8673b59c27 /docs/policies.rst
parent89ee717b9db8f55c4a5c100eb39b5bb0e5354d86 (diff)
downloadsos-217358a297664a8fb8419ef8fa21499f88d7eb85.tar.gz
[docs] add policies api reference
Include the base policy plugin reference in the auto-generated documentation. Signed-off-by: Adam Stokes <adam.stokes@ubuntu.com>
Diffstat (limited to 'docs/policies.rst')
-rw-r--r--docs/policies.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/policies.rst b/docs/policies.rst
new file mode 100644
index 00000000..9a2ccd72
--- /dev/null
+++ b/docs/policies.rst
@@ -0,0 +1,8 @@
+``sos.plugins`` --- Policy Interface
+====================================
+
+.. automodule:: sos.policy
+ :noindex:
+ :members:
+ :undoc-members:
+ :show-inheritance: