Issue #7045: Plugin Writer API Reference is out of date - Pulp

Actions

Send by e-mail Copy link

Issue #7045

closed

Plugin Writer API Reference is out of date

Added by bmbouter over 4 years ago. Updated about 4 years ago.

Status:

CLOSED - CURRENTRELEASE

Priority:

Normal

Assignee:

mdellweg

Category:

Sprint/Milestone:

3.7.0

Start date:

Due date:

Estimated time:

Severity:

2. Medium

Version:

Platform Release:

OS:

Triaged:

Yes

Groomed:

Sprint Candidate:

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

Copy link

Updated by ipanova@redhat.com over 4 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

Copy link