Project

Profile

Help

Task #4766

Switch docs to use RTD

Added by bmbouter 6 months ago. Updated 6 months ago.

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

100%

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

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

Blocks Ansible Plugin - Task #4842: Add API docs to website MODIFIED Actions

Associated revisions

Revision ef950c95 View on GitHub
Added by bmbouter 6 months ago

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

History

#1 Updated by daviddavis 6 months ago

  • Sprint set to Sprint 53

#2 Updated by bmbouter 6 months ago

  • Blocks Task #4842: Add API docs to website added

#3 Updated by bmbouter 6 months ago

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

#4 Updated by bmbouter 6 months 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 6 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