从 Python 文档字符串自动生成 GitHub Wiki 文档

Question

标题说明了一切。 我的想象是为我的所有模块、类和函数提供文档字符串，并以某种方式通过 github（wiki？）很好地导航文档。 此外，文档应该与最新代码同步，这意味着它应该在推送时更新/重新生成。 那可能吗？

Answer 1

只需将docstring的输出传递给.md文件即可。

像这样：

pydoc 'example_lib > example_lib.md .

Answer 2

Pydoc 不生成降价，它生成一个临时文本标记，只是偶尔碰巧匹配降价。 您需要有一个临时文本到降价转换器，这会失败很多，就像使用原始临时文本一样，就好像它已经是降价一样。