check_sphinx_api_html 実行例

help出力 check_sphinx_api_html.py --help

usage: check_sphinx_api_html.py [-h] [--root ROOT] [--files FILES]
                                [--outfile OUTFILE] [--exclude EXCLUDE]
                                [--min-text-len MIN_TEXT_LEN]
                                [--show-ok {0,1}]

Check Sphinx *_api.html files and list pages where autodoc output looks empty.

options:
  -h, --help            show this help message and exit
  --root ROOT           search root directory. default: .
  --files FILES         wildcard pattern for target files. default:
                        "*_api.html"
  --outfile OUTFILE     output file path. default: failed_api_html.txt
  --exclude EXCLUDE     exclude path keyword. Can be used multiple times.
  --min-text-len MIN_TEXT_LEN
                        minimum main text length. default: 300
  --show-ok {0,1}       show OK files too. default: 0


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

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

生成された画像一覧

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