Project

Profile

Help

Task #4766

Switch docs to use RTD

Added by bmbouter about 1 year ago. Updated about 1 year ago.

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

100%

Estimated time:
Platform Release:
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation
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 websiteMODIFIED

<a title="Actions" class="icon-only icon-actions js-contextmenu" href="#">Actions</a>

Associated revisions

Revision ef950c95 View on GitHub
Added by bmbouter about 1 year 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 about 1 year ago

  • Sprint set to Sprint 53

#2 Updated by bmbouter about 1 year ago

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

#3 Updated by bmbouter about 1 year ago

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

#4 Updated by bmbouter about 1 year 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 1 year ago

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

Please register to edit this issue

Also available in: Atom PDF