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

我正在为使用Numpy样式文档的Python项目编写文档。

numpydoc和拿破仑是两个解析Numpy风格文档来生成文档的Sphinx扩展。 第一个用于Numpy项目本身,第二个用于狮身人面像。

使用一个扩展优于另一个扩展的优点和缺点是什么?


每种结果的格式都有点不同,并且napoleon的默认行为链接到python文档中的已知数据类型,并且稍微更加精简( numpydoc显示的有点像它在docstring中的显示方式)。 下面是每个例子,都使用默认的sphinx主题。

astropy的问题跟踪器中astropy的一个问题是, napoleanIPython的硬依赖关系,并且他们从numpydoc迁移到napolean

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


拿破仑


在这里输入图像描述


numpydoc


在这里输入图像描述

链接地址: http://www.djcxy.com/p/91415.html

上一篇: Difference between sphinxcontrib.napoleon and numpy.numpydoc

下一篇: Tooltip not showing