Project

Profile

Help

Issue #7045

closed

Plugin Writer API Reference is out of date

Added by bmbouter over 2 years ago. Updated about 2 years 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.

Actions #1

Updated by ipanova@redhat.com over 2 years 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:
Actions #2

Updated by daviddavis over 2 years ago

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

Per triage

Actions #3

Updated by rchan about 2 years ago

  • Sprint changed from Sprint 76 to Sprint 77
Actions #4

Updated by rchan about 2 years ago

  • Sprint changed from Sprint 77 to Sprint 78
Actions #5

Updated by rchan about 2 years ago

  • Sprint changed from Sprint 78 to Sprint 79
Actions #6

Updated by mdellweg about 2 years ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to mdellweg
Actions #7

Updated by pulpbot about 2 years ago

  • Status changed from ASSIGNED to POST

Added by mdellweg about 2 years ago

Revision 8ae09608

Add :members: to plugin api reference

This includes all classes to the autogenerated API reference again.

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

Actions #8

Updated by mdellweg about 2 years ago

  • Status changed from POST to MODIFIED
Actions #9

Updated by bmbouter about 2 years ago

  • Sprint/Milestone set to 3.7.0
Actions #10

Updated by pulpbot about 2 years ago

  • Status changed from MODIFIED to CLOSED - CURRENTRELEASE

Also available in: Atom PDF