Issue #7045
Plugin Writer API Reference is out of date
Status:
NEW
Priority:
Normal
Assignee:
-
Category:
-
Start date:
Due date:
Estimated time:
Severity:
2. Medium
Version:
Platform Release:
OS:
Triaged:
Yes
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation
Sprint:
Sprint 79
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.
History
#1
Updated by ipanova@redhat.com about 2 months ago
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:
#2
Updated by daviddavis about 2 months ago
- Triaged changed from No to Yes
- Sprint set to Sprint 76
Per triage
#3
Updated by rchan about 1 month ago
- Sprint changed from Sprint 76 to Sprint 77
Please register to edit this issue
.