Actions
Task #1522
closed
Have types documentation autogenerate the docs from docstrings on mongoengine models
Status:
CLOSED - WONTFIX
Priority:
Normal
Assignee:
-
Category:
-
Sprint/Milestone:
-
Start date:
Due date:
% Done:
0%
Estimated time:
Platform Release:
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation, Pulp 2
Sprint:
Quarter:
Description
Each plugin is expected to have a section of API documentation which document the unit types it uses. Instead of writing RST files for these docs we should have sphinx auto-generate them from docstrings on the unit models themselves. This will let use not repeat ourselves which has caused at least one issue (#1429).
This is a bug on platform but it will likely take a PR in each plugin to do it.
Related issues
Actions
.