2013-01-24 24 views
11

當建立HTML文檔時,你如何強制獅身人面像報告,或創建一個錯誤,在不存在的鏈接?有獅身人面像報告損壞的鏈接

具體來說,我有我的Python項目中的屬性和方法已被刪除或重命名,並很難找到所有的死鏈接與獅身人面像生成的HTML輸出。

我覺得我正盯着這裏的答案: http://sphinx-doc.org/glossary.html,如在開篇中所描述的。

我顯然不理解的東西。

回答

4

我認爲CheckExternalLinksBuilder是你在找什麼。

它基本上通過調用'sphinx-build'與-b linkcheck選項使用。有關更多信息,請參閱sphinx-build。另外,請看一下sphinx-extensions的列表herehere

+2

這不適用於查找我的Python項目中已被刪除或重命名的屬性和方法。它似乎只適用於外部鏈接。 – Idaho

+0

好吧,我明白了。我不確定找到破碎的屬性或方法是獅身人面像的工作。聽起來像pylint,pyflakes是工作的正確工具。 – alecxe

12

nitpicky配置變量設置爲True(運行sphinx-build時,也可以使用-n option)。

在nitpicky模式下,對函數(如:func:`myfunc`),類或其他無法找到的對象的交叉引用將生成警告消息。

+0

真棒,在項目conf.py文件中添加「nitpicky = True」修復了它。 – Idaho

+2

非常好的答案!有沒有辦法將這些警告重定向到一個文件? – jsmedmar

+1

@jsmedmar,你有沒有試過使用[** - w **](http://www.sphinx-doc.org/en/stable/invocation.html#cmdoption-sphinx-build-w)選項? – mzjn