问题描述
我有一个python项目，其中包含每个函数，方法和类的文档字符串。如何以一种用户友好的方式自动将其显示在存储库的Wiki或存储库中的其他专用位置上？ （我不知道这类事情通常用在什么地方）
注意：这个问题是关于python docstrings的，但是如果有某种通用的方法可以对GitHub中的所有文档类型（例如C＃中的XML文档，Java中的Javadoc等）进行处理，那会更好
解决方法
使用pydoc将您的文档字符串通过管道传输到.md文件，然后将其上传到您的Github存储库Wiki：
sys库的示例：
Windows CMD
python -m pydoc sys > sys.md
Linux / WSL / OS X
pydoc sys > sys.md