aboutsummaryrefslogtreecommitdiffstats
path: root/docs/utilities.rst
Commit message (Collapse)AuthorAgeFilesLines
* [docs] Correct automodule definitions for sphinx docsJake Hunsaker2022-04-281-1/+0
| | | | | | | | | | | | | | | | | 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] - Add API documentation generationAdam Stokes2014-08-011-0/+8
Use sphinx to generate api docs which we can tie into a service like Read the docs in order to have reference documentation on our apis. Signed-off-by: Adam Stokes <adam.stokes@ubuntu.com>