diff options
| author | Adam Stokes <adam.stokes@ubuntu.com> | 2014-08-07 16:23:38 +0200 |
|---|---|---|
| committer | Bryn M. Reeves <bmr@redhat.com> | 2014-08-07 17:50:14 +0100 |
| commit | 217358a297664a8fb8419ef8fa21499f88d7eb85 (patch) | |
| tree | bef01e2477204fbb5dc673d3c23f6d8673b59c27 | |
| parent | 89ee717b9db8f55c4a5c100eb39b5bb0e5354d86 (diff) | |
| download | sos-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>
| -rw-r--r-- | docs/index.rst | 1 | ||||
| -rw-r--r-- | docs/policies.rst | 8 |
2 files changed, 9 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst index 77fa5eba..cd3bf199 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -92,5 +92,6 @@ Core Reference :maxdepth: 2 archive + policies reporting utilities 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: |