diff options
| author | Jake Hunsaker <jhunsake@redhat.com> | 2022-04-25 16:05:54 -0400 |
|---|---|---|
| committer | Jake Hunsaker <jhunsake@redhat.com> | 2022-04-28 11:03:14 -0400 |
| commit | 7e09f98fa8592441d6f53d27ce7a700b491a2d47 (patch) | |
| tree | d4d90006be20c42a04d7b507e8d3e8d3c93dcfb4 /docs | |
| parent | 95912b2ff2430700e659caaee66bd292322eb964 (diff) | |
| download | sos-7e09f98fa8592441d6f53d27ce7a700b491a2d47.tar.gz | |
[docs] Correct automodule definitions for sphinx docs
Building sphinx docs was generating warnings for several locations about
sphinx being unable to reference certain classes.
This was found to be due to the `automodule` definitions for each
section including the `:noindex:` setting. Removing this configuration
resolved the vast majority of cross-referencing warnings that sphinx
would report on during a build of the docs.
Note that a single warning will remain, referencing threading.Thread,
after this change.
Closes: #2917
Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/archive.rst | 8 | ||||
| -rw-r--r-- | docs/clusters.rst | 2 | ||||
| -rw-r--r-- | docs/parsers.rst | 2 | ||||
| -rw-r--r-- | docs/plugins.rst | 2 | ||||
| -rw-r--r-- | docs/policies.rst | 2 | ||||
| -rw-r--r-- | docs/reporting.rst | 1 | ||||
| -rw-r--r-- | docs/utilities.rst | 1 |
7 files changed, 12 insertions, 6 deletions
diff --git a/docs/archive.rst b/docs/archive.rst index 17c21a7c..9cdaedd0 100644 --- a/docs/archive.rst +++ b/docs/archive.rst @@ -6,3 +6,11 @@ :members: :undoc-members: :show-inheritance: + +.. autoclass:: sos.archive.Archive + :members: + :undoc-members: + +.. autoclass:: sos.archive.FileCacheArchive + :members: + :undoc-members: diff --git a/docs/clusters.rst b/docs/clusters.rst index 5a0c34cb..836651cb 100644 --- a/docs/clusters.rst +++ b/docs/clusters.rst @@ -2,6 +2,6 @@ ================================================= .. automodule:: sos.collector.clusters - :noindex: :members: + :undoc-members: :show-inheritance: diff --git a/docs/parsers.rst b/docs/parsers.rst index c747a186..e93d2a43 100644 --- a/docs/parsers.rst +++ b/docs/parsers.rst @@ -2,6 +2,6 @@ ============================================= .. automodule:: sos.cleaner.parsers - :noindex: :members: + :undoc-members: :show-inheritance: diff --git a/docs/plugins.rst b/docs/plugins.rst index a1fb0627..e8afb25c 100644 --- a/docs/plugins.rst +++ b/docs/plugins.rst @@ -2,6 +2,6 @@ =========================================== .. automodule:: sos.report.plugins - :noindex: :members: + :undoc-members: :show-inheritance: diff --git a/docs/policies.rst b/docs/policies.rst index eeca0f56..d6348734 100644 --- a/docs/policies.rst +++ b/docs/policies.rst @@ -2,6 +2,6 @@ ===================================== .. automodule:: sos.policies - :noindex: :members: + :undoc-members: :show-inheritance: diff --git a/docs/reporting.rst b/docs/reporting.rst index d4c48a50..a1b56ab7 100644 --- a/docs/reporting.rst +++ b/docs/reporting.rst @@ -2,7 +2,6 @@ ================================================ .. automodule:: sos.report.reporting - :noindex: :members: :undoc-members: :show-inheritance: diff --git a/docs/utilities.rst b/docs/utilities.rst index a9f7bcf0..a312b1f8 100644 --- a/docs/utilities.rst +++ b/docs/utilities.rst @@ -2,7 +2,6 @@ ======================================== .. automodule:: sos.utilities - :noindex: :members: :undoc-members: :show-inheritance: |