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.

Sign up for GitHub

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

Jump to bottom

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
@rashidakanchwala
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
@rashidakanchwala rashidakanchwala moved this to Inbox in Kedro-Viz Jan 30, 2024
@rashidakanchwala rashidakanchwala moved this from Inbox to Backlog in Kedro-Viz Jan 30, 2024
@rashidakanchwala rashidakanchwala mentioned this issue May 17, 2024
Merged
5 tasks
@rashidakanchwala rashidakanchwala added the Quick Win Low/Medium priorities but quick to do label Jul 18, 2024
@rashidakanchwala rashidakanchwala moved this from Backlog to Todo in Kedro-Viz Jul 22, 2024
@astrojuanlu astrojuanlu mentioned this issue Jul 29, 2024
Closed
1 task
@rashidakanchwala rashidakanchwala moved this from Todo to Backlog in Kedro-Viz Aug 5, 2024
@rashidakanchwala rashidakanchwala moved this from Backlog to Todo in Kedro-Viz Aug 19, 2024
@rashidakanchwala rashidakanchwala moved this from Todo to In Progress in Kedro-Viz Aug 19, 2024
@rashidakanchwala rashidakanchwala self-assigned this Aug 19, 2024
@rashidakanchwala rashidakanchwala mentioned this issue Aug 19, 2024
Merged
5 tasks
@rashidakanchwala rashidakanchwala moved this from In Progress to In Review in Kedro-Viz Aug 19, 2024
rashidakanchwala added a commit that referenced this issue Aug 19, 2024
@rashidakanchwala
Docs for Kedro-Viz CLI (#2044)
7e15c70 
Resolves #1705
@github-project-automation github-project-automation bot moved this from In Review to Done in Kedro-Viz Aug 19, 2024
@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
Assignees

@rashidakanchwala rashidakanchwala

Labels
Documentation Issue: Feature Request Quick Win Low/Medium priorities but quick to do
Projects
Kedro-Viz
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Docs for Kedro-Viz CLI kedro-org/kedro-viz
2 participants
@astrojuanlu @rashidakanchwala