diff options
| author | Jake Hunsaker <jhunsake@redhat.com> | 2020-07-24 11:43:01 -0400 |
|---|---|---|
| committer | Jake Hunsaker <jhunsake@redhat.com> | 2020-08-17 11:41:52 -0400 |
| commit | bef0ac86d830993c5599fd8d55d86685187ee8c1 (patch) | |
| tree | d659da7d8d947ecb4fc526f3edf0b173545c09a7 /docs | |
| parent | ee35c914fc46ff924af95528f005e2a3c61aaa62 (diff) | |
| download | sos-bef0ac86d830993c5599fd8d55d86685187ee8c1.tar.gz | |
[docs] Update sphinx doc generation
Updates the sphinx configuration for 4.0 and extends the generated docs
to cover parsers and clusters. Updates the location of plugins to the
new structure.
Updates setup.py to include sphinx build configuration, as we are no
longer using make.
Closes: #1991
Resolves: #2172
Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/clusters.rst | 8 | ||||
| -rw-r--r-- | docs/conf.py | 4 | ||||
| -rw-r--r-- | docs/index.rst | 6 | ||||
| -rw-r--r-- | docs/parsers.rst | 8 | ||||
| -rw-r--r-- | docs/plugins.rst | 6 | ||||
| -rw-r--r-- | docs/reporting.rst | 6 |
6 files changed, 28 insertions, 10 deletions
diff --git a/docs/clusters.rst b/docs/clusters.rst new file mode 100644 index 00000000..4388edb0 --- /dev/null +++ b/docs/clusters.rst @@ -0,0 +1,8 @@ +``sos.collector.clusters`` --- Cluster Profiles +================================================ + +.. automodule:: sos.collector.clusters + :noindex: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/conf.py b/docs/conf.py index 2452a8c2..058b28e3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -59,9 +59,9 @@ copyright = '2014, Bryn Reeves' # built documents. # # The short X.Y version. -version = '3.2' +version = '3.9' # The full version, including alpha/beta/rc tags. -release = '3.2' +release = '3.9.1' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/index.rst b/docs/index.rst index b6c27429..b86832c6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -87,15 +87,17 @@ Plugin Reference :maxdepth: 2 plugins - + clusters + parsers Core Reference ^^^^^^^^^^^^^^ .. toctree:: - :maxdepth: 2 + :maxdepth: 4 archive policies + plugins reporting utilities diff --git a/docs/parsers.rst b/docs/parsers.rst new file mode 100644 index 00000000..4d8e2656 --- /dev/null +++ b/docs/parsers.rst @@ -0,0 +1,8 @@ +``sos.cleaner.parsers`` --- Cleaning Parser Definition +======================================================= + +.. automodule:: sos.cleaner.parsers + :noindex: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/plugins.rst b/docs/plugins.rst index 6cc95424..9df84227 100644 --- a/docs/plugins.rst +++ b/docs/plugins.rst @@ -1,7 +1,7 @@ -``sos.plugins`` --- Plugin Interface -==================================== +``sos.report.plugins`` --- Plugin Interface +=========================================== -.. automodule:: sos.plugins +.. automodule:: sos.report.plugins :noindex: :members: :undoc-members: diff --git a/docs/reporting.rst b/docs/reporting.rst index 30c617a0..d4c48a50 100644 --- a/docs/reporting.rst +++ b/docs/reporting.rst @@ -1,7 +1,7 @@ -``sos.reporting`` --- Reporting Interface -========================================= +``sos.report.reporting`` --- Reporting Interface +================================================ -.. automodule:: sos.reporting +.. automodule:: sos.report.reporting :noindex: :members: :undoc-members: |