Task #4766
Switch docs to use RTD
Start date:
Due date:
% Done:
100%
Estimated time:
Platform Release:
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation
Sprint:
Sprint 53
Quarter:
Description
Switching to a read the docs site will make our docs more readable, searchable, and allow us to host the API docs like RPM does here: https://docs.pulpproject.org/en/3.0/nightly/restapi.html
Related issues
Associated revisions
History
#1
Updated by daviddavis about 2 years ago
- Sprint set to Sprint 53
#2
Updated by bmbouter about 2 years ago
- Blocks Task #4842: Add API docs to website added
#3
Updated by bmbouter about 2 years ago
- Status changed from NEW to ASSIGNED
- Assignee set to bmbouter
#4
Updated by bmbouter about 2 years ago
- Status changed from ASSIGNED to POST
sphinx project PR is here: https://github.com/pulp/pulp_ansible/pull/100
once merged I an enable the RTD site.
#5
Updated by bmbouter about 2 years ago
- Status changed from POST to MODIFIED
- % Done changed from 0 to 100
Applied in changeset pulp_ansible|ef950c953db00f577027a731a669cafb4a546265.
Please register to edit this issue
.
Convert to sphinx and majorly reorganize
This introduces a Sphinx docs project and moves almost all of the content from the README into the sphinx site. After merging, this will be enabled onto read the docs.
This also reworks the workflows sections significantly and follows the _snippets approach pioneered in pulp_python.
https://pulp.plan.io/issues/4766 closes #4766