sphinxcontrib.napoleon和numpy.numpydoc之间的区别

Question

我正在使用Numpy风格的文档字符串编写Python项目的文档.

numpydoc和napoleon是两个Sphinx扩展,它解析Numpy风格的文档字符串以生成文档.第一个用于Numpy项目本身,第二个用于Sphinx.

使用一个扩展而不是另一个扩展的优缺点是什么？

Answer 1

每个结果的格式有点不同,以及文档中napoleon已知数据类型的链接的默认行为python,并且它稍微有点浓缩(numpydoc显示有点像它在docstring中的显示方式).以下是每个示例,均使用默认的sphinx主题.

astropy问题跟踪器中的一个问题是,状态napolean是一种硬依赖关系IPython,并且他们已经迁移numpydoc到了napolean.

他们提到它有更严格的语法要求,但我没有测试过太多评论.

拿破仑

numpydoc