Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: allow publishing generated api cli docs #410

Open
mvidalgarcia opened this issue Apr 15, 2020 · 0 comments
Open

docs: allow publishing generated api cli docs #410

mvidalgarcia opened this issue Apr 15, 2020 · 0 comments

Comments

@mvidalgarcia
Copy link
Member

Stems from #409 (review)

Current behavior

We have generate_cli_api.py script to generate the docs that go into https://docs.reana.io/reference/reana-client-cli-api/. ATM one has to manually copy the generated output to the corresponding file in docs.reana.io doing something like python scripts/generate_cli_api.py | pbcopy.

Desired behavior

Have the possibility to copy the autogenerated content to the docs.reana.io repo.

Solution

Add an option to copy the generated docs file automatically into docs.reana.io/docs/reference/reana-client-cli-api/index.md. RWC is doing something similar for the openapi specs.
Evaluate if it's worth converting the script into a mini click cli tool.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant