Project

Profile

Help

Task #1522

closed

Have types documentation autogenerate the docs from docstrings on mongoengine models

Added by bmbouter over 8 years ago. Updated about 5 years ago.

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

Has duplicate RPM Support - Issue #1429: Unit docs are incorrect and should have all fields defined on modelsCLOSED - DUPLICATEActions
Actions #1

Updated by bmbouter over 8 years ago

  • Has duplicate Issue #1429: Unit docs are incorrect and should have all fields defined on models added
Actions #2

Updated by mhrivnak about 8 years ago

  • Sprint Candidate changed from Yes to No
Actions #3

Updated by bmbouter over 5 years ago

  • Status changed from NEW to CLOSED - WONTFIX
Actions #4

Updated by bmbouter over 5 years ago

Pulp 2 is approaching maintenance mode, and this Pulp 2 ticket is not being actively worked on. As such, it is being closed as WONTFIX. Pulp 2 is still accepting contributions though, so if you want to contribute a fix for this ticket, please reopen or comment on it. If you don't have permissions to reopen this ticket, or you want to discuss an issue, please reach out via the developer mailing list.

Actions #5

Updated by bmbouter about 5 years ago

  • Tags Pulp 2 added

Also available in: Atom PDF