python - スフィンクスが壊れたリンクを報告する

Question

HTMLドキュメントを作成するとき、存在しないリンクについてsphinxにレポートを強制したり、エラーを作成したりするにはどうすればよいですか？

具体的には、Pythonプロジェクト内に削除または名前変更されたプロパティとメソッドがあり、スフィンクスで生成されたhtml出力ですべてのデッドリンクを見つけるのは困難です。

冒頭の段落で説明したように、私はここで答えを見つめているような気がします： http : //sphinx-doc.org/glossary.html。

私は明らかに何かを理解していません。

Answer 1

nitpicky構成変数を に設定します ( sphinx-build の実行時に-n オプションTrueを使用することもできます)。

nitpicky モードでは、見つからない関数 ( など:func:`myfunc`)、クラス、またはその他のオブジェクトへの相互参照により、警告メッセージが生成されます。

Answer 2

私CheckExternalLinksBuilderはあなたが探しているものだと思います。

基本的には「sphinx-build」を-b linkcheckオプションで呼び出して使用します。詳細については、を参照sphinx-buildしてください。また、sphinx-extensions のリストをこちらとこちらでご覧ください。