diff options
| author | Adam Stokes <adam.stokes@ubuntu.com> | 2014-08-01 11:57:27 -0400 |
|---|---|---|
| committer | Bryn M. Reeves <bmr@redhat.com> | 2014-08-01 17:31:59 +0100 |
| commit | 84c238706d58ac870ab27bdb0695db57c2423857 (patch) | |
| tree | fbe85522d305f8539064f0dc5b5c14bc82510a1c /docs/reporting.rst | |
| parent | 8c662fa9d2b5f36c2ead473b27399d1aa190a721 (diff) | |
| download | sos-84c238706d58ac870ab27bdb0695db57c2423857.tar.gz | |
[docs] - Add API documentation generation
Use sphinx to generate api docs which we can tie into a service like
Read the docs in order to have reference documentation on our apis.
Signed-off-by: Adam Stokes <adam.stokes@ubuntu.com>
Diffstat (limited to 'docs/reporting.rst')
| -rw-r--r-- | docs/reporting.rst | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/reporting.rst b/docs/reporting.rst new file mode 100644 index 00000000..30c617a0 --- /dev/null +++ b/docs/reporting.rst @@ -0,0 +1,8 @@ +``sos.reporting`` --- Reporting Interface +========================================= + +.. automodule:: sos.reporting + :noindex: + :members: + :undoc-members: + :show-inheritance: |