Skip to content

Conversation

@spicy-sauce
Copy link

and:
typo in README: docPath instead of docsPath

- click version in requirements should be updated RiveryIO#7
- typo in README: docPath instead of docsPath
@spicy-sauce
Copy link
Author

Please update to PyPI once approving.
Thanks!

Copy link

@matofeder matofeder left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thx for this PR! It fixes issues also on my end. PR has been tested and works as expected.
Would be great to merge and release it.

@matofeder
Copy link

Thx for this PR! It fixes issues also on my end. PR has been tested and works as expected. Would be great to merge and release it.

To all who are still waiting for this PR:
My use case is to produce a single markdown file as CLI documentation. In addition, linking the subcommand with the parent command and vice-versa is good for user navigation in the docs, as well as brief TOC. All mentioned is possible with my helper script.
You can find the script here and generated docs here.
Usage:

pip install -r docs/helpers/requirements.txt
python docs/helpers/mdclick.py --module=yaookctl.cli --cmd=yaookctl --output=./docs/src/yaookctl_cli.md

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

Successfully merging this pull request may close these issues.

2 participants