Project

Profile

Help

Task #6660

Add script for generating docs for python clients

Added by fao89 10 months ago. Updated 6 months ago.

Status:
POST
Priority:
Normal
Assignee:
Category:
-
Sprint/Milestone:
-
Start date:
Due date:
% Done:

0%

Estimated time:
(Total: 0:00 h)
Platform Release:
Groomed:
Yes
Sprint Candidate:
Yes
Tags:
Sprint:
Sprint 81
Quarter:

Description

Description

The auto generated documentation produced by openapi-generator-cli needs to be published with the rest of pulpcore and plugin docs.

The documentation produced by openapi-generator-cli is in Markdown format. The rest of Pulp documentation uses reStructuredText.

m2r can be used to convert Markdown to reStructuredText[0]. A script should be written that uses m2r to generate the documentation using openapi-generator-cli and convert it to reStructuredText. This script should then copy the documentation into the docs directory of a plugin.

[0] https://github.com/miyakogi/m2r


Subtasks

File Support - Task #6659: Add script for generating docs for python clientPOSTfao89

Actions

History

#1 Updated by fao89 10 months ago

  • Subject changed from https://pulp.plan.io/issues/6518 to Add script for generating docs for python clients

I accidentally removed https://pulp.plan.io/issues/6518

#2 Updated by rchan 10 months ago

  • Sprint changed from Sprint 72 to Sprint 73

#3 Updated by rchan 9 months ago

  • Sprint changed from Sprint 73 to Sprint 74

#4 Updated by rchan 9 months ago

  • Sprint changed from Sprint 74 to Sprint 75

#5 Updated by rchan 8 months ago

  • Sprint changed from Sprint 75 to Sprint 76

#6 Updated by rchan 8 months ago

  • Sprint changed from Sprint 76 to Sprint 77

#7 Updated by fao89 7 months ago

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

#8 Updated by pulpbot 7 months ago

  • Status changed from ASSIGNED to POST

#9 Updated by rchan 7 months ago

  • Sprint changed from Sprint 77 to Sprint 78

#10 Updated by rchan 7 months ago

  • Sprint changed from Sprint 78 to Sprint 79

#11 Updated by rchan 6 months ago

  • Sprint changed from Sprint 79 to Sprint 80

#12 Updated by rchan 6 months ago

  • Sprint changed from Sprint 80 to Sprint 81

#13 Updated by dalley 6 months ago

Should this transition back to assigned? (the PR is closed)

Please register to edit this issue

Also available in: Atom PDF