Project

Profile

Help

Task #1860

Have web and plugin APIs generated from docstrings

Added by bmbouter over 4 years ago. Updated over 1 year ago.

Status:
CLOSED - WONTFIX
Priority:
Normal
Assignee:
-
Category:
-
Start date:
Due date:
% Done:

0%

Estimated time:
Platform Release:
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation, Pulp 2
Sprint:
Quarter:

Description

The API documentation should be auto-generated from the docstrings of the public Pulp interfaces. Specifically this should be true for the web API and also for the plugin API.

The docs should have the same content only we should remove the .rst files and have the docs built from the docstrings instead. Docstrings should be modified some to produce equivalent documentation to what we already have.

History

#1 Updated by bmbouter over 4 years ago

  • Subject changed from Have APIs generated from docstrings to Have web and plugin APIs generated from docstrings

#2 Updated by mhrivnak over 4 years ago

  • Sprint Candidate changed from Yes to No

#3 Updated by bmbouter over 1 year ago

  • Status changed from NEW to CLOSED - WONTFIX

#4 Updated by bmbouter over 1 year 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.

#5 Updated by bmbouter over 1 year ago

  • Tags Pulp 2 added

Please register to edit this issue

Also available in: Atom PDF