| Commit message (Collapse) | Author | Age | Files | Lines |
|---|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
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>
|
| |
|
|
|
|
|
|
|
|
| |
Standardizes the docstrings within `Plugin()` to adhere to Sphinx-style
annotation, to assist with the effort to improve auto documentation
generation from Sphinx.
Related: #2172
Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
| |
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>
|
|
|
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>
|
