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

【问题标题】：Documenting python script entry (__name__ == '__main__') using sphinx使用 sphinx 记录 python 脚本条目 (__name__ == '__main__')
【发布时间】：2020-10-04 01:24:34
【问题描述】：

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

if __name__ == '__main__':

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

【问题讨论】：

我尝试在测试下方放置一个文档字符串。我终于“看到了曙光”并使用了下面的策略（函数）。

标签： python python-sphinx autodoc

【解决方案1】：

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

【讨论】：