Project

Profile

Help

Task #6660

closed

Add script for generating docs for python clients

Added by fao89 almost 4 years ago. Updated about 2 years ago.

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

100%

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

Description

Ticket moved to GitHub: "pulp/pulpcore/1891":https://github.com/pulp/pulpcore/issues/1891


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


Sub-issues 1 (0 open1 closed)

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

Actions
Actions #1

Updated by fao89 almost 4 years 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

Actions #2

Updated by rchan almost 4 years ago

  • Sprint changed from Sprint 72 to Sprint 73
Actions #3

Updated by rchan almost 4 years ago

  • Sprint changed from Sprint 73 to Sprint 74
Actions #4

Updated by rchan almost 4 years ago

  • Sprint changed from Sprint 74 to Sprint 75
Actions #5

Updated by rchan almost 4 years ago

  • Sprint changed from Sprint 75 to Sprint 76
Actions #6

Updated by rchan almost 4 years ago

  • Sprint changed from Sprint 76 to Sprint 77
Actions #7

Updated by fao89 over 3 years ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to fao89
Actions #8

Updated by pulpbot over 3 years ago

  • Status changed from ASSIGNED to POST
Actions #9

Updated by rchan over 3 years ago

  • Sprint changed from Sprint 77 to Sprint 78
Actions #10

Updated by rchan over 3 years ago

  • Sprint changed from Sprint 78 to Sprint 79
Actions #11

Updated by rchan over 3 years ago

  • Sprint changed from Sprint 79 to Sprint 80
Actions #12

Updated by rchan over 3 years ago

  • Sprint changed from Sprint 80 to Sprint 81
Actions #13

Updated by dalley over 3 years ago

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

Actions #14

Updated by pulpbot about 2 years ago

  • Description updated (diff)
  • Status changed from POST to CLOSED - DUPLICATE

Also available in: Atom PDF