aboutsummaryrefslogtreecommitdiffstats
path: root/docs/policies.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|policy] Update Policy to sphinx-style docstringsJake Hunsaker2020-08-171-1/+0
| | | | | | | | | Updates the `Policy` and related docstrings to Sphinx-style as part of the work to bring the API docs up to date. Related: #2172 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [docs]: Cleaned minor errors while generating docsSachin Patil2016-04-251-1/+1
| | | | | | | | * Implemented proper code snippet in docstring * Removed '_static/' from html_static_path as it was not used and hence throwing error Signed-off-by: Sachin Patil <sacpatil@redhat.com>
* [docs] fix policy section headingsBryn M. Reeves2014-08-071-3/+3
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [docs] add policies api referenceAdam Stokes2014-08-071-0/+8
Include the base policy plugin reference in the auto-generated documentation. Signed-off-by: Adam Stokes <adam.stokes@ubuntu.com>