Project

Profile

Help

Actions
Send by e-mail Copy link

Task #1860

closed

Have web and plugin APIs generated from docstrings

Added by bmbouter about 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

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.

Actions
Copy link
 #1

Updated by bmbouter about 8 years ago

  • Subject changed from Have APIs generated from docstrings to Have web and plugin APIs generated from docstrings
Actions
Copy link
 #2

Updated by mhrivnak almost 8 years ago

  • Sprint Candidate changed from Yes to No
Actions
Copy link
 #3

Updated by bmbouter about 5 years ago

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

Updated by bmbouter about 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
Copy link
 #5

Updated by bmbouter about 5 years ago

  • Tags Pulp 2 added
Actions
Send by e-mail Copy link

Also available in: Atom PDF