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

docs: add automatic generation of CLI reference #325

Merged
merged 2 commits into from
Nov 15, 2024
Merged

Conversation

dolfim-ibm
Copy link
Contributor

Make the CLI reference automatic generated.

Checklist:

  • Commit Message Formatting: Commit titles and messages follow guidelines in the
    conventional commits.
  • Documentation has been updated, if necessary.
  • Examples have been added, if necessary.
  • Tests have been added, if necessary.

Signed-off-by: Michele Dolfi <dol@zurich.ibm.com>
@dolfim-ibm
Copy link
Contributor Author

CI fails because creating the automatic references (cli and api) requires having module installed. Putting this temporary on hold.

Signed-off-by: Michele Dolfi <dol@zurich.ibm.com>
Copy link
Contributor

@cau-git cau-git left a comment

Choose a reason for hiding this comment

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

LGTM

@dolfim-ibm dolfim-ibm merged commit ca8524e into main Nov 15, 2024
7 of 8 checks passed
@dolfim-ibm dolfim-ibm deleted the docs-auto-cli branch November 15, 2024 12:18
Copy link

mergify bot commented Nov 15, 2024

Merge Protections

Your pull request matches the following merge protections and will not be merged until they are valid.

🔴 Require two reviewer for test updates

This rule is failing.

When test data is updated, we require two reviewers

  • #approved-reviews-by >= 2

🟢 Enforce conventional commit

Wonderful, this rule succeeded.

Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/

  • title ~= ^(fix|feat|docs|style|refactor|perf|test|build|ci|chore|revert)(?:\(.+\))?:

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