使用 sphinx 记录 python 脚本条目 (__name__ == '__main__')
[英]Documenting python script entry (__name__ == '__main__') using sphinx
问题描述
Is there a way, ideally using autodoc , to get sphinx to document a Python script?
有没有办法，理想情况下使用autodoc ，让 sphinx 记录 Python 脚本？ 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.即仅当模块用作脚本而不是被导入时才运行的位。
1 个解决方案
解决方案1
4 2015-06-11 12:13:19
您应该将该块中的代码提取到一个带有文档字符串的函数中，然后从该块中调用该函数。
声明:本站的技术帖子网页，遵循CC BY-SA 4.0协议，如果您需要转载，请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.
相关问题
如果 __name__ == '__main__' python - if __name__ == '__main__' python
比在 Python 脚本中两次 if __name__ == '__main__' 更好的解决方案 - Better solution than if __name__ == '__main__' twice in Python script
无法从 Python 脚本中的 `if __name__ == "__main__"` 返回值？ - Cannot return value from `if __name__ == "__main__"` in a Python script?
如何使用if __name__ =='__main__'条件创建控制台脚本？ - How to create a console script using if __name__ == ' __main__' condition?
在Python多处理中使用__name __ =='__ main__'的解决方法 - Workaround for using __name__=='__main__' in Python multiprocessing
Mocking 没有 `if __name__=="__main__":` 块的脚本 - Mocking a script with no `if __name__=="__main__":` block
使用python-multiprocessing与if __name__ =='__main__'相关的谜 - enigma using python-multiprocessing related with if __name__ == '__main__'
如果 __name__ == "__main__"： - If __name__ == "__main__":
emacs 中的 Python：__name__ == '__main__'，但不知何故 - Python in emacs: __name__ == '__main__', but somehow not
Windows 上的 python 多处理，如果 __name__ == “__main__” - python multiprocessing on windows, if __name__ == “__main__”
相关标签