test: add unit tests for the docs scripts

[shenxianpeng]

Summary

This PR adds unit tests for the docs scripts, which raises coverage. It changes nothing else.

• Coverage: docs/*.py, the only Python in the repository, goes from 0% (no tests) to 100% line and branch coverage (coverage.py with branch = true and source = ["docs"]).
  • tests/test_gen_io_doc.py runs docs/gen_io_doc.py the way mkdocs-gen-files does. It checks that every input and output in action.yml is documented with its version, default and description. It also covers how each kind of metadata is rendered, the annotation for an undocumented field, and the build failures for incomplete metadata.
  • tests/test_badge_hook.py covers every badge type in docs/badge_hook.py and its error paths.
  • To run them, there is a test dependency group (pytest and coverage; uv.lock only gains these packages), pytest and coverage settings in pyproject.toml, and a Run tests workflow. Run them locally with uv run --group test pytest.
• SHA pinning: nothing to change. All tag references were already pinned to commit SHAs; the @main reusable workflows and ./ stay as they are.
• Checkout credentials: nothing to change. Every actions/checkout step already sets persist-credentials: false, except release.yml, which needs the credentials to push the rolling tag.

Related Issues

None.

[github-actions]

Cpp-Linter Report ⚠️

Some files did not pass the configured checks!

clang-format (v16.0.6) reports: 2 file(s) not formatted

• docs/examples/demo/demo.hpp
• docs/examples/demo/demo.cpp

clang-tidy (v16.0.6) reports: 7 concern(s)

• docs/examples/demo/demo.hpp:6:11: warning: [modernize-use-default-member-init]

  use default member initializer for 'useless'

      char* useless;
            ^
                   {"\0"}

• docs/examples/demo/demo.hpp:7:9: warning: [modernize-use-default-member-init]

  use default member initializer for 'numb'

      int numb;
          ^
              {0}

• docs/examples/demo/demo.hpp:11:11: warning: [modernize-use-trailing-return-type]

  use a trailing return type for this function

      void *not_useful(char *str){useless = str;}
      ~~~~~~^
      auto                        -> void *

• docs/examples/demo/demo.cpp:3:10: warning: [modernize-deprecated-headers]

  inclusion of deprecated C++ header 'stdio.h'; consider using 'cstdio' instead

  #include <stdio.h>
           ^~~~~~~~~
           <cstdio>

• docs/examples/demo/demo.cpp:8:5: warning: [modernize-use-trailing-return-type]

  use a trailing return type for this function

  int main(){
  ~~~ ^
  auto       -> int

• docs/examples/demo/demo.cpp:10:13: warning: [readability-braces-around-statements]

  statement should be inside braces

      for (;;) break;
              ^
               {

• docs/examples/demo/demo.cpp:13:5: warning: [cppcoreguidelines-pro-type-vararg]

  do not call c-style vararg functions

      printf("Hello world!\n");
      ^

Have any feedback or feature suggestions? Share it here.

[shenxianpeng]

It seems there is no need to add tests for the badge hook and docs. closing.