2014-03-28 74 views
3

我想用Sphinx 1.2.1來記錄我的Python包。獅身人面像不包括編譯期間的源代碼

我對第一個文件的定義包含一些關於每個模塊的描述,用法和爲重新構造的文本添加autodoc語法如下。

module 
------ 

.. automodule:: RAT.REPORTER.bemrstcreator 
    :members: 
    :undoc-members: 
    :show-inheritance: 

上述設置爲我創建了一個清晰的html版本,沒有任何問題。它從所有類,它的相關成員等中派生出文檔,但是它包含了html中的源代碼。我如何指示獅身人面像不鏈接每個模塊的源代碼?

+0

猜測:你需要禁用[sphinx.ext.viewcode](http://sphinx-doc.org/ext/viewcode.html)擴展名。 – mzjn

+0

謝謝。只需將其從conf.py中的擴展中刪除即可。工作得很好。 – Sri

回答

2

在conf.py中,關於特定文檔的所有修改都刪除了sphinx.ext.viewcode擴展名。

# Add any Sphinx extension module names here, as strings. They can be 
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 
# ones. 
extensions = [ 
    'sphinx.ext.autodoc', 
    'sphinx.ext.viewcode', 
    'rst2pdf.pdfbuilder' 
] 

以上修改爲

extensions = [ 
    'sphinx.ext.autodoc', 
    'rst2pdf.pdfbuilder' 
] 
6

你可以找到下一個配置值,在config.py文件,並將其設置爲false:

html_show_sourcelink = False