スフィンクスに壊れたリンクがあると報告する

Question

htmlドキュメントを作成する際に、存在しないリンク上でスフィンクスに報告したり、エラーを作成したりするにはどうすればよいですか？

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

私はここの答えを見つめているように感じます： http://sphinx-doc.org/glossary.html、はじめの段落で説明されています。

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

Answer 1

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

基本的には、 'sphinx-build'を-b linkcheckオプションと呼んで使用します。詳細はsphinx-buildをご覧ください。また、スフィンクスエクステンションhereとhereのリストを見てください。

Answer 2

nitpicky設定変数をTrueに設定してください（また、-n optionは、sphinx-build実行時に使用できます）。

ニッキーピッドモードでは、関数（例：:func:`myfunc`）、クラス、または見つからない他のオブジェクトへの相互参照によって警告メッセージが生成されます。