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

[doc] incus list documentation formatting #1421

Closed
bensmrs opened this issue Nov 26, 2024 · 1 comment
Closed

[doc] incus list documentation formatting #1421

bensmrs opened this issue Nov 26, 2024 · 1 comment
Assignees
Labels
Documentation Documentation needs updating
Milestone

Comments

@bensmrs
Copy link
Contributor

bensmrs commented Nov 26, 2024

https://linuxcontainers.org/incus/docs/main/reference/manpages/incus/list/, generated from doc/reference/manpages/incus/list.md, in turn generated from the manpages, is wrongly formatted. Additional processing should be done on the command description.

@stgraber
Copy link
Member

Hmm, we basically entirely rely on spf13/cobra for that stuff. Using the markdown output from incus manpage PATH --format=md --all, so we'd need to try and tweak the input to get a more suitable output.

@stgraber stgraber added Bug Documentation Documentation needs updating labels Nov 30, 2024
@stgraber stgraber self-assigned this Nov 30, 2024
@stgraber stgraber added this to the incus-6.8 milestone Nov 30, 2024
stgraber added a commit that referenced this issue Dec 4, 2024
Closes #1421

Signed-off-by: Stéphane Graber <stgraber@stgraber.org>
bketelsen pushed a commit to bketelsen/incus that referenced this issue Feb 4, 2025
Closes lxc#1421

Signed-off-by: Stéphane Graber <stgraber@stgraber.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation needs updating
Development

No branches or pull requests

2 participants