我无法使用numpy格式正确使用Sphinx。 我正在使用此example进行测试,执行" make html",但我收到了几个警告来识别参数,注释,返回等。例如:
SEVERE: Unexpected section title.
ERROR: Unexpected indentation.
also
WARNING: Inline emphasis start-string without end-string.
WARNING: Literal block expected; none found
这个问题已经被提出,但在搜索并尝试了几个小时后我没有成功。
到目前为止我做了什么:
numpydoc
更新为版本0.5 numpydoc
,sphinxcontrib.napoleon
和sphinx.ext.napoleon
添加到conf.py
文件中。numpydoc_show_class_members = False
添加到conf.py
有什么建议或提示是什么问题?我能尝试什么?
由于
答案 0 :(得分:1)
问题是我使用numpydoc直接用.. toctree:: filename
来记录模块,但它必须与.. automodule:: filename
一起使用。有关如何在此处使用它的更多信息:http://www.sphinx-doc.org/en/stable/tutorial.html#setting-up-the-documentation-sources。谢谢你的帮助。