LemurPwned / video-sampler

Effective frame sampling for ML applications.
https://lemurpwned.github.io/video-sampler/
MIT License
16 stars 5 forks source link

cli help script added #27

Closed LemurPwned closed 3 weeks ago

LemurPwned commented 3 weeks ago

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:

sourcery-ai[bot] commented 3 weeks ago

Reviewer's Guide by Sourcery

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.

Sequence Diagram

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

File-Level Changes

Change Details Files
Add CLI help generation script
  • Create a new Python script to generate CLI help documentation
  • Implement a function to run CLI commands and capture their help output
  • Generate Markdown-formatted documentation for main command and subcommands
scripts/cli_help.py
Update mkdocs configuration
  • Add the new CLI help script to the hooks section
  • Include a new 'CLI Reference' page in the navigation
mkdocs.yml

Tips and commands #### Interacting with Sourcery - **Trigger a new review:** Comment `@sourcery-ai review` on the pull request. - **Continue discussions:** Reply directly to Sourcery's review comments. - **Generate a GitHub issue from a review comment:** Ask Sourcery to create an issue from a review comment by replying to it. #### Customizing Your Experience Access your [dashboard](https://app.sourcery.ai) to: - Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others. - Change the review language. - Add, remove or edit custom review instructions. - Adjust other review settings. #### Getting Help - [Contact our support team](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourceryai/) or [GitHub](https://github.com/sourcery-ai).