Closed LemurPwned closed 3 weeks ago
This pull request adds a CLI help script to generate documentation for the command-line interface of the video-sampler project. The changes include adding a new Python script for generating CLI help documentation and updating the mkdocs configuration to include the generated documentation in the project's documentation structure.
sequenceDiagram
participant MkDocs
participant CLIHelpScript
participant Subprocess
participant MarkdownFile
MkDocs->>CLIHelpScript: Execute on_startup
CLIHelpScript->>MarkdownFile: Create cli_help.md
loop For each subcommand
CLIHelpScript->>Subprocess: Run CLI with --help
Subprocess-->>CLIHelpScript: Return help output
CLIHelpScript->>MarkdownFile: Write formatted help output
end
Change | Details | Files |
---|---|---|
Add CLI help generation script |
|
scripts/cli_help.py |
Update mkdocs configuration |
|
mkdocs.yml |
Summary by Sourcery
Add a script to generate CLI help documentation and update the mkdocs configuration to include this new documentation section.
New Features:
Enhancements:
Documentation: