Closed. This question is opinion-based。它当前不接受答案。
想要改善这个问题吗？更新问题，以便editing this post用事实和引用来回答。
3年前关闭。
Improve this question
我正在使用Numpy-style docstrings为Python项目编写文档。
numpydoc和napoleon是两个Sphinx扩展名，用于解析Numpy样式的文档字符串以生成文档。第一个用于Numpy项目本身，第二个与Sphinx一起提供。
使用一个扩展而不是另一个扩展的优缺点是什么？
想要改善这个问题吗？更新问题，以便editing this post用事实和引用来回答。
3年前关闭。
Improve this question
我正在使用Numpy-style docstrings为Python项目编写文档。
numpydoc和napoleon是两个Sphinx扩展名，用于解析Numpy样式的文档字符串以生成文档。第一个用于Numpy项目本身，第二个与Sphinx一起提供。
使用一个扩展而不是另一个扩展的优缺点是什么？
最佳答案
每种格式的结果格式略有不同，并且napoleon的默认行为链接到python文档中的已知数据类型，并且更加简洁(numpydoc显示的有点像它在文档字符串中的显示方式)。以下是每个示例的示例，均使用默认的狮身人面像主题。astropy的问题跟踪程序中的An issue指出napolean是IPython的硬依赖性，并且此后已从numpydoc迁移到napolean。
他们提到它对语法有更严格的要求，但是我也没有对此进行过多的测试。
拿破仑
numpydoc
09-30 20:21