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

2022-04-22 00:00:00 python python-sphinx autodoc

问题描述

我正在尝试为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('../../'))

相关文章