我正在使用Numpy风格的文档字符串为Python项目编写文档。
numpydoc 和 napoleon 是两个Sphinx扩展，用于解析Numpy风格的文档字符串以生成文档。第一个扩展被用于Numpy项目本身，而第二个扩展则随Sphinx一起发布。
使用其中一个扩展有哪些优缺点？
使用其中一个扩展有哪些优缺点？
sphinxcontrib.napoleon和numpy.numpydoc之间的区别
14
- nbedou
1
3我不明白为什么这个问题被关闭了。这个问题似乎是完全有效的，可以得到一个相当客观的回答。 - James Mchugh
1个回答
14
每个格式的结果略有不同，
他们提到它有更严格的语法要求，但我还没有对任何一种进行过太多测试，无法发表评论。
napoleon 的默认行为是链接到 python 文档中已知的数据类型，并且稍微更加简洁（numpydoc 显示类似于 docstring 中出现的方式）。以下是两种示例，都使用默认的 Sphinx 主题。
astropy 的问题跟踪器中有一个问题，其中指出 napolean 是 IPython 的硬依赖项，他们已经从 numpydoc 迁移到了 napolean。他们提到它有更严格的语法要求，但我还没有对任何一种进行过太多测试，无法发表评论。
拿破仑
numpydoc
- ryanjdillon
2
这个使用了什么 Sphinx 主题？ - bad_coder
1@bad_coder 我想是Alabaster。 - ryanjdillon
网页内容由stack overflow 提供, 点击上面的可以查看英文原文，
原文链接
原文链接
- 相关问题
- 9 tf.layers.conv2d和tf.contrib.slim.conv2d之间的区别
- 21 np.nan和np.NaN之间的区别
- 17 Python：!= 和 "is not" 之间的区别
- 30 numpy.logical_and和&之间的区别
- 3 scipy.interpolate.griddata和scipy.interpolate.Rbf之间的区别
- 7 open()和path.open()之间的区别
- 7 MiniBatchKMeans.fit和MiniBatchKMeans.partial_fit之间的区别
- 7 tf.layers.dense和tf.nn.xw_plus_b之间的区别
- 3 a[:,None]和a[:,]之间的区别
- 6 add_form和form之间的区别