python - 使用 sphinx 记录 python 脚本条目 (__name__ == '__main__')

Question

有没有一种方法，最好是使用 autodoc，让 sphinx 记录 Python 脚本？我要记录的脚本部分是受以下保护的部分:

if __name__ == '__main__':

即仅当模块用作脚本而不是导入时才运行的位。

Answer 1

您应该将该 block 中的代码提取到一个带有文档字符串的函数中，然后从该 block 中调用该函数。