從 Python 文檔字符串自動生成 GitHub Wiki 文檔

Question

標題說明了一切。 我的想象是為我的所有模塊、類和函數提供文檔字符串，並以某種方式通過 github（wiki？）很好地導航文檔。 此外，文檔應該與最新代碼同步，這意味着它應該在推送時更新/重新生成。 那可能嗎？

Answer 1

只需將docstring的輸出傳遞給.md文件即可。

像這樣：

pydoc 'example_lib > example_lib.md .

Answer 2

Pydoc 不生成降價，它生成一個臨時文本標記，只是偶爾碰巧匹配降價。 您需要有一個臨時文本到降價轉換器，這會失敗很多，就像使用原始臨時文本一樣，就好像它已經是降價一樣。