我正在使用Numpy 样式的 docstrings为 Python 项目编写文档。
numpydoc和napoleon是两个 Sphinx 扩展，它们解析 Numpy 样式的文档字符串以生成文档。第一个用于 Numpy 项目本身，第二个与 Sphinx 一起提供。
使用一个扩展而不是另一个的优点和缺点是什么？
问问题
1801 次
1 回答
14
生成的每个格式都有点不同，并且napoleon链接到python文档中已知数据类型的默认行为，并且稍微更简洁（numpydoc显示有点像它在文档字符串中的显示方式）。下面是每个示例，都使用默认的 sphinx 主题。
的astropy问题跟踪器中的一个问题状态是napolean硬依赖IPython，并且它们已经从迁移numpydoc到napolean.
他们提到它有更严格的语法要求，但我还没有测试太多来评论它。
拿破仑
numpydoc
于 2017-07-10T10:25:59.043 回答