假设我具有以下Python文件,并尝试使用Sphinx对其进行记录
"""The foo module.
"""
def foo(s):
"""The foo function.
:param s: a string
"""
return s + "!"
def bar(x, y=foo('Baz')):
"""The bar function.
:param x: a string
:param y: another string
"""
return x + y
if __name__ == "__main__":
print(bar('hello '))
此文件位于以下目录结构中的__init__.py
.
├── docs
│ ├── _build
│ ├── conf.py
│ ├── index.rst
│ ├── Makefile
│ ├── _static
│ └── _templates
└── foo
└── __init__.py
当我在doc /下的.rst文件中使用.. automodule: foo
指令时,bar
的{{1}}参数被评估为'Baz!'。如this pic中所示。有没有办法防止这种评估,而是让导出的文档改为阅读y
?
以下是y=foo('Baz')
的内容:
conf.py