Project

Profile

Help

Task #6660

closed

Add script for generating docs for python clients

Added by fao89 almost 4 years ago. Updated over 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

Also available in: Atom PDF