Python 如何将文档字符串显示到存储库中'；什么是维基？

我有一个python项目，它包含每个函数、方法和类的docstring。如何以用户友好的方式将其自动显示到存储库的wiki或存储库中的其他专用位置？（我不知道这类东西通常放在什么地方）

注意：问题是关于python docstring的，但是如果GitHub中的所有文档类型（例如C#中的XML文档、Java中的Javadoc等）都有一些通用方法，那么最好使用管道将您的docstring传输到

.md

文件并将其上传到GitHub repo wiki：

sys

库的示例：

Windows CMD

python -m pydoc sys > sys.md

Linux/WSL/OS X

pydoc sys > sys.md

---

您可以编写一个脚本，从.py文件（或任何语言的文档）中获取每个docstring，然后将其格式化并输出到documentation.txt文件中。@AAAlex123否则无法显示docstring吗？（就像在python文档中一样？）顺便说一句，我正在使用PyCharm。也许它有这样的功能，我可以使用它，然后以某种方式传输到GitHub？当然有，但如果没有，或者您想要一个更可定制的解决方案，我建议脚本如何将它用于python包？@avivgood2这可以用于任何python模块/文件。例如，您有一个

example.py

，然后您可以执行

pydoc example>example.md

。我不应该指定完整路径吗？您应该使用

cd

首先进入与模块相同的目录。确定。最后一个问题。我应该使用python控制台/cmd/shell提示符吗？（使用Windows 10）