如何将文档字符串显示到存储库的 Wiki 中?
How to display docstrings into a repository's Wiki?
我有一个 python 项目,其中包含每个函数、方法和 class 的文档字符串。我怎样才能以用户友好的方式自动将其显示到存储库的 wiki 或存储库中的其他专用位置? (我不知道这种东西通常用在什么地方)
注意:问题是关于 python 文档字符串,但是如果有一些通用的方法可以对所有文档类型执行此操作(例如 C# 中的 XML 文档,C# 中的 Javadoc Java, 等..) 在 GitHub 中会更好
使用 pydoc 将您的文档字符串传输到 .md
文件并将其上传到您的 Github 维基百科:
sys
库示例:
Windows命令
python -m pydoc sys > sys.md
Linux/WSL/OS X
pydoc sys > sys.md
我有一个 python 项目,其中包含每个函数、方法和 class 的文档字符串。我怎样才能以用户友好的方式自动将其显示到存储库的 wiki 或存储库中的其他专用位置? (我不知道这种东西通常用在什么地方)
注意:问题是关于 python 文档字符串,但是如果有一些通用的方法可以对所有文档类型执行此操作(例如 C# 中的 XML 文档,C# 中的 Javadoc Java, 等..) 在 GitHub 中会更好
使用 pydoc 将您的文档字符串传输到 .md
文件并将其上传到您的 Github 维基百科:
sys
库示例:
Windows命令
python -m pydoc sys > sys.md
Linux/WSL/OS X
pydoc sys > sys.md