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

Send by e-mail

Issue #7045

Plugin Writer API Reference is out of date

Added by bmbouter 7 months ago. Updated 4 months 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.

Associated revisions

Revision 8ae09608 View on GitHub
Added by mdellweg 5 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 7 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: