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

Add CLI reference #1705

Closed
1 task
astrojuanlu opened this issue Jan 16, 2024 · 1 comment · Fixed by #2044
Closed
1 task

Add CLI reference #1705

astrojuanlu opened this issue Jan 16, 2024 · 1 comment · Fixed by #2044
Assignees
Labels
Documentation Issue: Feature Request Quick Win Low/Medium priorities but quick to do

Comments

@astrojuanlu
Copy link
Member

Description

It would be nice to have a CLI reference for kedro viz subcommands.

Context

I was wondering what the output of kedro viz run --save-file should be, so I went to the documentation. But the docs explain usage, there is no reference docs (related: kedro-org/kedro#2604)

Possible Implementation

https://sphinx-click.readthedocs.io/

image

Possible Alternatives

...

Checklist

  • Include labels so that we can categorise your feature request
@astrojuanlu
Copy link
Member Author

To note, the fact that this is manually generated means that now we have to remember to document new commands or flags manually, see #2077 cc @rashidakanchwala

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issue: Feature Request Quick Win Low/Medium priorities but quick to do
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants