2014-09-24 33 views
1

我有一些模塊級別的變量,我想從自動生成的文檔中排除很長且無趣的值。有沒有辦法做到這一點?如何省略Sphinx上的變量值?

例如,在我的Python源我有類似

#:This is a variable with a log value. 
long_variable = "Some really long value that is not really of interest and just kind of gets in the way of reading and understanding what's going on." 

,並在我的獅身人面像源我有

.. automodule:: the_module 
    :members: 

,我想的文檔,省略變量值。

如何省略Sphinx上的變量值?有沒有辦法在Python源代碼中爲特定變量執行此操作?我可以在獅身人面像源中爲整個模塊或單個變量執行嗎?

+0

也許你可以使用這個:http://stackoverflow.com/a/25163963/407651 – mzjn 2014-09-25 15:52:48

+0

@mzjn:這比我所希望的要多。有沒有我可以添加到變量的裝飾器。或者可能是RST的一面旗幟? – orome 2014-09-25 16:52:41

+1

有一個「註釋」選項,但它只適用於'autodata'和'autoattribute':http://sphinx-doc.org/ext/autodoc.html?highlight=autodata#directive-autodata – mzjn 2014-09-25 17:08:53

回答