Project

Profile

Help

Task #4842

closed

Add API docs to website

Added by bmbouter over 3 years ago. Updated about 2 years ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
Assignee:
Sprint/Milestone:
Start date:
Due date:
% Done:

100%

Estimated time:
Platform Release:
Groomed:
Yes
Sprint Candidate:
No
Tags:
Documentation
Sprint:
Sprint 53
Quarter:

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 RTDCLOSED - CURRENTRELEASEbmbouter

Actions
Actions #1

Updated by bmbouter over 3 years ago

  • Description updated (diff)
Actions #2

Updated by bmbouter over 3 years ago

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

Updated by daviddavis over 3 years ago

  • Groomed changed from No to Yes
  • Sprint set to Sprint 53
Actions #4

Updated by bmbouter over 3 years ago

  • Description updated (diff)
Actions #5

Updated by daviddavis over 3 years ago

  • Sprint/Milestone set to 0.1 Release
Actions #6

Updated by bmbouter over 3 years ago

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

Added by bmbouter over 3 years ago

Revision 91f2c95f

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

Actions #7

Updated by bmbouter over 3 years ago

  • Status changed from ASSIGNED to POST
Actions #8

Updated by bmbouter over 3 years ago

  • Status changed from POST to MODIFIED
  • % Done changed from 0 to 100
Actions #9

Updated by bmbouter about 2 years ago

  • Status changed from MODIFIED to CLOSED - CURRENTRELEASE

Also available in: Atom PDF