check_sphinx_api_rst 実行例

help出力 check_sphinx_api_rst.py --help

usage: check_sphinx_api_rst.py [-h] [--root ROOT] [--files FILES]
                               [--outfile OUTFILE] [--exclude EXCLUDE]
                               [--show-ok {0,1}] [--fix] [--dry-run]

Check Sphinx *_api.rst files for invalid automodule names and argv usage
without __main__ guard in corresponding .py files.

options:
  -h, --help         show this help message and exit
  --root ROOT        Sphinx source root directory. default: "./source"
  --files FILES      wildcard pattern for target RST files. default:
                     "*_api.rst"
  --outfile OUTFILE  output file path. default: "failed_api_rst.txt"
  --exclude EXCLUDE  exclude path keyword. Can be used multiple times.
  --show-ok {0,1}    show OK files too. default: 0
  --fix              automatically fix '-' and path separators in automodule
                     names when safe.
  --dry-run          show planned fixes without modifying files. Use with
                     --fix.

生成されたデータファイル

（データファイルが見つかりませんでした）

生成された画像一覧

（画像ファイルが見つかりませんでした）