generate full CLI docs from click's metadata and also added it in precommit hooks #1096
Conversation
|
@georgeh0 I have added a Readme /dev was earlier thinking no need to, but added for clarity, pls confirm do we need it or not ? |
Davda-James
force-pushed
the
feat/full-cli-docs-from-click
branch
from
5b7deb0 to
6ca74a1
Compare
|
@georgeh0 resolved the test-docs ci failing issue now, all checks passed |
| sys.path.insert(0, str(python_path)) | ||
|
|
||
| try: | ||
| import md_click |
There was a problem hiding this comment.
I think we want to add this as an optional dependency at
Line 65 in 661f8d7
docs/docs/core/cli.mdx
Outdated
| cocoindex show --help # Show usage of "show" subcommand | ||
| ``` | ||
|
|
||
| ## Detailed Command Reference |
There was a problem hiding this comment.
Wondering will it work if we directly import the file?
This can be tested out by yarn start under the docs/ directory.
Also if import works, the "Subcommands" section above can also be removed as it's already generated. And top-level headers / overviews from the generated markdown can also be removed.
Let me know if import doesn't work. We can submit it as is. Thanks!
There was a problem hiding this comment.
@georgeh0 done its working, will soon add commit.
There was a problem hiding this comment.
Fixing some formatting so markdownlinter do not cry..
This provides more background. We can keep it. Thanks! |
…ored cli generation to fix markdownlinter issues
3 participants
Generate full CLI docs from click's metadata and also added it in pre commit hooks
Ran precommit hooks.
Added one Readme for clearance what /(dev contains if not needed will remove it pls tell me)
docs will be generated at docs/docs/core/cli-reference.md also added it in pre commit hooks (can check in image, name: generate-cli-docs)