如何以編程方式更新python文件中的文檔字符串

Question

我在同一個文件夾中有一堆（大約 23 個）.py 文件，每個文件中總共有大約 50 個以上的函數，並且相應的文檔字符串已更新為 csv 或文本文件 是否有任何文檔實用程序或python 包將有助於以編程方式更新這些 python 文件中的文檔字符串？

Answer 1

Python 非常適合文檔/測試框架。

一個非常酷的是'readthedocs' 框架。

安裝獅身人面像

pip install sphinx

並初始化一個新的 docs 文件夾項目

mkdir docs
cd $_
sphinx-quickstart

完成后，您將能夠通過在該文件夾中運行 make 命令來創建文檔

make html

現在您可以手動修改文檔。 這里有詳細步驟

https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html

如果您想自定義替換大量文件中的單個單詞，您將面臨破壞代碼的風險。 這里沒有 sed/grep 組合會有所幫助。

相反，您必須制作一個僅過濾評論文本（# 和“””）並更新單詞的 python 腳本