Automatically Generate GitHub Wiki Documentation from Python Docstrings

后端 未结 1 1658
陌清茗
陌清茗 2021-02-13 12:09

The title says it all. What I imagine is to have docstrings for all of my modules, classes and functions and somehow nicely navigate the doc via github (wiki?). Also, the doc sh

1条回答
  •  不知归路
    2021-02-13 12:40

    Just pipe the output of the docstring to a .md file.

    Like this:

    pydoc 'example_lib > example_lib.md .
    

    0 讨论(0)
提交回复
热议问题