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

Question

我正在使用Numpy-style docstrings编写Python项目的文档。

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

使用一个扩展名比另一个扩展名有什么优缺点？

Answer 1

每个结果的格式有点不同，napoleon的默认行为链接到python文档中的已知数据类型，并且稍微有点浓缩（numpydoc显示一点就像它在docstring中的表现一样）。以下是每个示例，均使用默认的sphinx主题。

astropy问题跟踪器中的{p> An issue表示napolean是IPython的硬依赖关系，他们已从numpydoc迁移过来到napolean。

他们提到它有更严格的语法要求，但我还没有对此进行过多评论。

<强>拿破仑

<强> numpydoc