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

Command category pages in docs don't display category descriptions #78

Open
pederhan opened this issue Aug 16, 2023 · 0 comments
Open

Command category pages in docs don't display category descriptions #78

pederhan opened this issue Aug 16, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@pederhan
Copy link
Member

The help text for a Typer app (command category) is not displayed in the docs pages for the category. I.e. The config page does not display the contents of help defined in the code:

https://github.com/pederhan/harbor-cli/blob/f3a79a0db5c0907b4850dc0aa80abefc567fe8ba/harbor_cli/commands/api/harbor_config.py#L19-L23
@pederhan pederhan added the documentation Improvements or additions to documentation label Aug 16, 2023
@pederhan pederhan added this to Harbor Aug 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@pederhan