aboutsummaryrefslogtreecommitdiffstats
path: root/docs/clusters.rst
Commit message (Collapse)AuthorAgeFilesLines
* [docs] Correct automodule definitions for sphinx docsJake Hunsaker2022-04-281-1/+1
| | | | | | | | | | | | | | | | | 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>
* [docs] Small fixes for RTD online generation changesJake Hunsaker2020-08-261-2/+2
| | | | | | | | | | A few changes on the RTD side in turn need us to slightly adjust some parts of our docs in-tree so that RTD can successfully build the docs online based on current master branch. Resolves: #2209 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [docs|clusters] Update docstrings to use Sphinx style formattingJake Hunsaker2020-08-171-1/+0
| | | | | | | | | Updates the docstrings for `Cluster()` to use SPhinx-style formatting as part of the effort to bring our Sphinx docs up to date. Related: #2172 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [docs] Update sphinx doc generationJake Hunsaker2020-08-171-0/+8
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>