mcpField
F
fix-sphix-docs

fix-sphix-docs

github.com/tradingstrategy-ai開発82971 回インストール今日更新
リポジトリ

fix-sphix-docs について

fix-sphix-docs は、Sphinx のドキュメントビルドを繰り返し、対応しやすいエラーや警告の修正を試みるスキルです。ビルドの待機時間を制限し、自動生成された RST ファイルは変更しません。

主な機能

  1. 01Sphinx HTML ビルドの実行
  2. 02ビルド待機時間の制限
  3. 03ビルドエラーと警告の確認
  4. 04自動生成 RST ファイルの除外
  5. 05変更報告と PR 作成の確認

活用シーン

  1. 01Sphinx ドキュメントビルドの問題調査
  2. 02対応しやすいドキュメント警告の修正
  3. 03ビルドのタイムアウト前に出力を確認
  4. 04ドキュメント修正 PR の準備

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/tradingstrategy-ai/web3-ethereum-defi --skill fix-sphix-docs

インストール後、Claude Code で/fix-sphix-docsを入力して読み込まれたか確認します。

詳細

Sphinx ドキュメントのビルドで発生するエラーと警告の修正

このスキルでは、Sphinx ドキュメントのビルドを繰り返し実行し、簡単に修正できるエラーや警告を解消します。

手順

  1. Sphinx のビルドを実行します:(source ./.venv/bin/activate && cd ./docs/ && make html)。ただし、60 秒後に中断する方法を調べてください。ビルド全体の完了を待つ必要はありません。
  2. 出力された警告とエラーを確認し、修正できそうなものに対応します。自動生成された RST ファイルには手を加えないでください。これらは _autosummary_d2 のような _autosummary フォルダー内にあります。ユーザーが、あなたの知らない特別なコマンドを使ってこれらのフォルダーを再作成します。
  3. 変更内容を報告します。
  4. PR を作成してもよいか確認します。

コメント