homelab/stack
1
0
Fork 0
Code Issues 251 Pull Requests 2 Actions Packages Projects 1 Releases Wiki Activity

Generate CLI usage documentation from typer help #27

New Issue
Closed
opened 2026-03-12 17:41:54 +00:00 by kert · 0 comments
kert commented 2026-03-12 17:41:54 +00:00
Owner
Copy Link

Auto-generate CLI docs:

  • Extract help text from every typer command
  • Render as markdown pages in mkdocs
  • Include examples for each command
  • Keep in sync with code (generated, not hand-written)
Auto-generate CLI docs: - Extract help text from every typer command - Render as markdown pages in mkdocs - Include examples for each command - Keep in sync with code (generated, not hand-written)
kert added this to the P7: Docs — Generated API docs, user guide, regulatory references milestone 2026-03-12 17:41:54 +00:00
kert added the clidocs labels 2026-03-12 17:41:54 +00:00
kert closed this issue 2026-03-12 21:37:59 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
api
REST API (FastAPI)
 auth
Authentication and authorization
 bib
Bibliography, Zotero, citations
 ci
CI/CD pipelines and Woodpecker plugins
 cli
CLI commands and UX
 cloud
Cloud provider abstraction (AWS, GCP, Azure, self-hosted)
 config
Configuration and wiring
 data
Data loading, CCLF, BCDA, seeds
 databricks
Databricks jobs and deployment
 docs
Documentation and generated references
 image:api
image:docs
image:mc
image:notebooks
image:zotero
infra
lakehouse
Nessie, Polaris, Trino, Iceberg
 llm
llm module — local RAG over comments + Zotero corpus
 notebooks
marimo notebook errors (auto-filed by nb-watcher/nb-integration)
 packaging
Python packaging, optional deps, build system
 pfs
pipeline
Pipeline execution and validation
 pipeline:ci
pipeline:deploy
pipeline:harden
pipeline:infra-ci
pipeline:rebuild-all
pipeline:release
qpp
quality
Testing, coverage, error handling
 step:build
step:deploy
step:hadolint
step:lint
step:publish
step:scan
step:test
step:validate
styles
Charts, figures, visual theming
 tree
Project directory structure and file organization
No Label cli docs
Milestone
No items
No Milestone P7: Docs — Generated API docs, user guide, regulatory references
Projects
Clear projects
No project
Assignees
Clear assignees
kert renovate-bot
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: homelab/stack#27
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?