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] usage.md needs to be updated with GHA CI in PRs #389

Open
vjeeva opened this issue Feb 21, 2024 · 0 comments
Open

[Docs] usage.md needs to be updated with GHA CI in PRs #389

vjeeva opened this issue Feb 21, 2024 · 0 comments

Comments

@vjeeva
Copy link
Contributor

vjeeva commented Feb 21, 2024

It has grown out of date, mainly due to tiangolo/typer-cli#120.

typer-cli is used to generate the usage docs, but the version pins on that are very outdated, since we use the latest typer v0.9.0.

The workaround for using typer-cli is to use pip to install it and ignore the version conflicts.

We need to get this doc generation at least into our Makefile for manual triggering, but also hopefully build this into CI on PRs so we don't lose track again.

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

No branches or pull requests

1 participant