Skip to content

Add CLI documentation#301

Merged
NotTheEvilOne merged 3 commits intomainfrom
feature/cli_docs
Feb 25, 2026
Merged

Add CLI documentation#301
NotTheEvilOne merged 3 commits intomainfrom
feature/cli_docs

Conversation

@yeoldegrove
Copy link
Contributor

What this PR does / why we need it:

This adds auto-generated CLI documentation via sphinx.
It also adds some missing help texts to CLI.
Finally, it adds some style ;)

Note for reviewer:
Needs #271 merged first.

@codecov
Copy link

codecov bot commented Feb 2, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.88%. Comparing base (f420f50) to head (0569798).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #301      +/-   ##
==========================================
+ Coverage   90.83%   90.88%   +0.05%     
==========================================
  Files          45       45              
  Lines        2269     2282      +13     
==========================================
+ Hits         2061     2074      +13     
  Misses        208      208              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Contributor

@ByteOtter ByteOtter left a comment

Choose a reason for hiding this comment

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

I always like more documentation, sphinx is nice for code docs like this and we can integrate it with #gardenlinux/gardenlinux#4329

Signed-off-by: Eike Waldt <waldt@b1-systems.de>
On-behalf-of: SAP <eike.waldt@sap.com>
Signed-off-by: Eike Waldt <waldt@b1-systems.de>
On-behalf-of: SAP <eike.waldt@sap.com>
@NotTheEvilOne NotTheEvilOne force-pushed the feature/cli_docs branch 3 times, most recently from 5f3895c to cd933d0 Compare February 25, 2026 13:28
Signed-off-by: Tobias Wolf <wolf@b1-systems.de>
On-behalf-of: SAP <tobias.wolf@sap.com>
@NotTheEvilOne NotTheEvilOne merged commit 8482a4a into main Feb 25, 2026
8 checks passed
@NotTheEvilOne NotTheEvilOne deleted the feature/cli_docs branch February 25, 2026 15:14
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.

3 participants