在sphinx autodoc

时间:2016-03-25 02:38:08

标签: python python-sphinx

我正在使用sphinx来自动修改python模块。例如,我的代码就像文件test.py中的代码一样:

Number2Name = {'1': u'中文', '3': u'英文'}
"""
字典数据结构 # Dictionary data structures
"""

当我在第一个文件中写这个时:

.. automodule:: test
    :members:

它将生成正确的html页面,但使用Unicode字符串而不是中文字符,例如:

test.Number2Name={'1': u'\u4e2d\u6587', '3': u'\u82f1\u6587'}
字典数据类型结构

当数据中包含越来越多的信息时,这会变得很烦人,因为它会在html页面中占据大量位置时提供不可读的信息。

所以我想知道Sphinx是否可以禁用在模块中显示变量的值。使页面像这样:

test.Number2Name
字典数据类型结构

我看了http://www.sphinx-doc.org/en/stable/ext/autodoc.html#module-sphinx.ext.autodoc但找不到解决方法。我想我应该修改sphinx源代码来支持这个功能吗?

1 个答案:

答案 0 :(得分:0)

如果是以UTF8编码,则应检查写文件。按另存为另一个,您可以选择编码(默认编码为ANSI)