Issue #7045
closed
Plugin Writer API Reference is out of date
Status:
CLOSED - CURRENTRELEASE
Description
Background¶
There is a section in the docs called "Plugin API Reference" section here which is driven by this portion of the docs. The idea is that our plugin API uses .. automodule::
statements to bring in the object documentation as a full reference in this section.
It is very outdated
Solution¶
Ensure that all objects in the plugin API are correctly represented in the reference by adding automodule
statements.
in order to fix the problem members
should be specified as well.
$ git diff
diff --git a/docs/plugins/api-reference/tasking.rst b/docs/plugins/api-reference/tasking.rst
index 680c17dc7..5999c0c84 100644
--- a/docs/plugins/api-reference/tasking.rst
+++ b/docs/plugins/api-reference/tasking.rst
@@ -4,4 +4,5 @@ pulpcore.plugin.tasking
All models documented here should be imported directly from the ``pulpcore.plugin.tasking`` namespace.
.. automodule:: pulpcore.plugin.tasking
+ :members:
:imported-members:
- Triaged changed from No to Yes
- Sprint set to Sprint 76
- Sprint changed from Sprint 76 to Sprint 77
- Sprint changed from Sprint 77 to Sprint 78
- Sprint changed from Sprint 78 to Sprint 79
- Status changed from NEW to ASSIGNED
- Assignee set to mdellweg
- Status changed from ASSIGNED to POST
- Status changed from POST to MODIFIED
- Sprint/Milestone set to 3.7.0
- Status changed from MODIFIED to CLOSED - CURRENTRELEASE
Also available in: Atom
PDF
Add :members: to plugin api reference
This includes all classes to the autogenerated API reference again.
fixes #7045 https://pulp.plan.io/issues/7045