Project

Profile

Help

Issue #7045

Plugin Writer API Reference is out of date

Added by bmbouter 4 months ago. Updated about 1 month ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
Assignee:
Category:
-
Sprint/Milestone:
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
Quarter:

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.

Associated revisions

Revision 8ae09608 View on GitHub
Added by mdellweg 2 months ago

Add :members: to plugin api reference

This includes all classes to the autogenerated API reference again.

fixes #7045 https://pulp.plan.io/issues/7045

History

#1 Updated by ipanova@redhat.com 4 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 4 months ago

  • Triaged changed from No to Yes
  • Sprint set to Sprint 76

Per triage

#3 Updated by rchan 4 months ago

  • Sprint changed from Sprint 76 to Sprint 77

#4 Updated by rchan 3 months ago

  • Sprint changed from Sprint 77 to Sprint 78

#5 Updated by rchan 3 months ago

  • Sprint changed from Sprint 78 to Sprint 79

#6 Updated by mdellweg 2 months ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to mdellweg

#7 Updated by pulpbot 2 months ago

  • Status changed from ASSIGNED to POST

#8 Updated by mdellweg 2 months ago

  • Status changed from POST to MODIFIED

#9 Updated by bmbouter about 1 month ago

  • Sprint/Milestone set to 3.7.0

#10 Updated by pulpbot about 1 month ago

  • Status changed from MODIFIED to CLOSED - CURRENTRELEASE

Please register to edit this issue

Also available in: Atom PDF