使用sphinx记录python脚本条目(__name__ =='__ main__')

时间:2015-06-11 12:06:44

标签: python documentation python-sphinx

有没有办法(最好使用autodoc)让sphinx记录Python脚本?我想记录的脚本部分是受以下内容保护的部分:

if __name__ == '__main__':

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

1 个答案:

答案 0 :(得分:4)

您应该使用docstring将该块中的代码提取到函数中,并从块中调用该函数。