Project

Profile

Help

Task #4842

Add API docs to website

Added by bmbouter 4 months ago. Updated 4 months ago.

Status:
MODIFIED
Priority:
Normal
Assignee:
Sprint/Milestone:
Start date:
Due date:
% Done:

100%

Platform Release:
Blocks Release:
Backwards Incompatible:
No
Groomed:
Yes
Sprint Candidate:
No
Tags:
Documentation
QA Contact:
Complexity:
Smash Test:
Verified:
No
Verification Required:
No
Sprint:
Sprint 53

Description

pulp_ansible should have API docs similar to what the pulp_file docs have here: https://pulp-file.readthedocs.io/en/latest/restapi/index.html

This does not need to include the Galaxy URLs, only for the Pulp components, e.g. AnsibleDistribution. It's ok if the Galaxy stuff is also there, just not a requirement.


Related issues

Blocked by Ansible Plugin - Task #4766: Switch docs to use RTD MODIFIED Actions

Associated revisions

Revision 91f2c95f View on GitHub
Added by bmbouter 4 months ago

Adds in a live API part to the docs!

The api.json asset will be updated everytime someone runs make html.
The committed api.json file drives the browsable version hosted on RTD.

https://pulp.plan.io/issues/4842
closes #4842

History

#1 Updated by bmbouter 4 months ago

  • Description updated (diff)

#2 Updated by bmbouter 4 months ago

  • Blocked by Task #4766: Switch docs to use RTD added

#3 Updated by daviddavis 4 months ago

  • Groomed changed from No to Yes
  • Sprint set to Sprint 53

#4 Updated by bmbouter 4 months ago

  • Description updated (diff)

#5 Updated by daviddavis 4 months ago

  • Sprint/Milestone set to 0.1 Release

#6 Updated by bmbouter 4 months ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to bmbouter

#7 Updated by bmbouter 4 months ago

  • Status changed from ASSIGNED to POST

#8 Updated by bmbouter 4 months ago

  • Status changed from POST to MODIFIED
  • % Done changed from 0 to 100

Please register to edit this issue

Also available in: Atom PDF