在狮身人面像中更新文档字符串

Updating docstring in sphinx(在狮身人面像中更新文档字符串)

本文介绍了在狮身人面像中更新文档字符串的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

我正在尝试为dask project的文档做出贡献。
我想添加this issue中建议的pandas引用。
我可以在我的开发人员计算机上重建文档,但在更新docstring时,我看不到文档中有任何更改。
例如,我尝试添加:meth:pandas.{reader}以更新csv.py中的READ_DOC_TEMPLATE,但未进行任何更新。
我尝试对docstring进行简单的更新(即更改文档字符串的措辞),但没有任何变化(即使我运行make clean)。

如有任何帮助,我们将不胜感激。

thx

推荐答案

as@mzjn评论: 解决方案是使用以下行更新(取消注释)conf.py

sys.path.insert(0, os.path.abspath('../../'))

这篇关于在狮身人面像中更新文档字符串的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持编程学习网!

本文标题为:在狮身人面像中更新文档字符串

基础教程推荐