使用Sphinx记录Python脚本入口(__name__ == '__main__')

3

有没有一种方法,最好使用autodoc,让sphinx文档化Python脚本?我想要文档化的部分是由以下代码保护的:

if __name__ == '__main__':

即只有在模块被用作脚本而不是被导入时才运行的部分。

我尝试在测试下面添加文档字符串。最终,我“看到了光明”,并使用了以下策略(函数)。 - Papadeltasierra
1个回答

4
你应该将该代码块中的代码提取到一个函数中,并添加文档字符串,在该块中调用该函数。

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接