Skip to content

doc-checker in the pre-commit#212

Open
murogrande wants to merge 8 commits intomainfrom
mm/doc_checker_pipeline
Open

doc-checker in the pre-commit#212
murogrande wants to merge 8 commits intomainfrom
mm/doc_checker_pipeline

Conversation

@murogrande
Copy link
Contributor

@murogrande murogrande commented Feb 3, 2026

integrating doc-checker to the current pre-commit.
There are 2 hooks:

    - id: doc-checker-basic
    language: system
    args: ["--warn-only","--ignore-submodules", "emu_mps.optimatrix"]
 - id: doc-checker-links
   language: system
   args: ["--ignore-submodules", "emu_mps.optimatrix"]
   verbose: true
  • the doc-checker-basic: checks if the api in docs contains all the classes, look for internal broken links and parameters in functions (only warning for the moment, which means that this will not stop for committing)
  • the doc-checker-link: will search for broken external links

for more information check doc-checker

TODO:

  • LLM backend part where doc-checker analyse the docstrings will be in a second phase.

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.

1 participant