Documenting python script entry (__name__ == '__main__') using sphinx

Question

Is there a way, ideally using autodoc , to get sphinx to document a Python script? The section of the script I want documented is the portion protected by:

if __name__ == '__main__':

ie the bit that only runs if the module is used as a script instead of being imported.

Answer 1

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