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

CLI: add gendoc cmd for docs #16436

Merged
merged 2 commits into from
Oct 1, 2024
Merged

CLI: add gendoc cmd for docs #16436

merged 2 commits into from
Oct 1, 2024

Conversation

naltatis
Copy link
Member

@naltatis naltatis commented Sep 30, 2024

see evcc-io/docs#633

Future steps (other PR)

  • auto generate and push cli docs on release (similar to device templates)

@naltatis naltatis added the enhancement New feature or request label Sep 30, 2024
@naltatis naltatis requested a review from andig September 30, 2024 19:40
cmd/gendock.go Outdated
Use: "gendoc <output-dir>",
Short: "Generate CLI documentation in markdown format",
Args: cobra.ExactArgs(1),
Run: func(cmd *cobra.Command, args []string) {
Copy link
Member

Choose a reason for hiding this comment

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

Können wir das noch wie sonst auf als Funktion raus ziehen? Nur aus Konsistenzgründen.

cmd/gendock.go Outdated
var gendocCmd = &cobra.Command{
Use: "gendoc <output-dir>",
Short: "Generate CLI documentation in markdown format",
Args: cobra.ExactArgs(1),
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Args: cobra.ExactArgs(1),
Args: cobra.ExactArgs(1),
Hidden: true,

@andig andig merged commit d07b8d2 into master Oct 1, 2024
6 checks passed
@andig andig deleted the docs/cli-markdown branch October 1, 2024 13:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants