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/archive.rst | |
| 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/archive.rst')
| -rw-r--r-- | docs/archive.rst | 8 |
1 files changed, 8 insertions, 0 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: |