-
Notifications
You must be signed in to change notification settings - Fork 1
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 documentation #114
Conversation
New pre-commit hook using the locally installed `typer` to generate the CLI documentation.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #114 +/- ##
==========================================
- Coverage 92.27% 92.27% -0.01%
==========================================
Files 27 27
Lines 1386 1385 -1
==========================================
- Hits 1279 1278 -1
Misses 107 107
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
The main issue is that it needs to run twice, since it first produces only the config sub-typer app documentation.
Reroute stderr to stdout before rerouting stdout to a file.
New
CLI.md
document in the root of thedocs
folder with a complete API documentation of the CLI.New pre-commit hook using the locally installedtyper
to auto-generate the CLI documentation.Not reasonable as it apparently takes two runs to generate the proper documentation.
To do: