Skip to content
This repository was archived by the owner on Apr 6, 2024. It is now read-only.
This repository was archived by the owner on Apr 6, 2024. It is now read-only.

Feature Request: utils command or flag for checking if generated mardown docs have changed. #103

Closed

Description

@sullivancolin

I'm not sure it this functionality belongs in typer-cli or should be implemented outside of it.

Basically, I'm interested in similar behavior to black --check or isort --check which can be run in CI or pre-commit to warn the developer that they need to run those tools. I have auto generated docs and I want them to be kept in sync with code changes to the CLI and trigger a CI failure if the previous version of the docs no longer matches what would be generated now. It wouldn't be too hard to implement this outside of typer-cli with a bash script, but curious if others would find it useful.

Activity

  1. Repository owner locked and limited conversation to collaborators on Apr 6, 2024
  2. converted this issue into a discussion #139 on Apr 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions