From 7e09f98fa8592441d6f53d27ce7a700b491a2d47 Mon Sep 17 00:00:00 2001 From: Jake Hunsaker Date: Mon, 25 Apr 2022 16:05:54 -0400 Subject: [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 --- docs/plugins.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/plugins.rst') 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: -- cgit