内容简介:标题说明了一切.我想象的是为我的所有模块,类和函数提供docstrings,并通过github(wiki?)以某种方式很好地导航文档.此外,文档应与最新代码同步,这意味着它应该在推送时更新/重新生成.那可能吗?翻译自:https://stackoverflow.com/questions/29660467/automatically-generate-github-wiki-documentation-from-python-docstrings
标题说明了一切.我想象的是为我的所有模块,类和函数提供docstrings,并通过github(wiki?)以某种方式很好地导航文档.此外,文档应与最新代码同步,这意味着它应该在推送时更新/重新生成.那可能吗?
只需将docstring的输出传递给.md文件即可.
像这样:
pydoc 'example_lib > example_lib.md .
翻译自:https://stackoverflow.com/questions/29660467/automatically-generate-github-wiki-documentation-from-python-docstrings
以上所述就是小编给大家介绍的《从Python Docstrings自动生成GitHub Wiki文档》,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对 码农网 的支持!
本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们。
C++程序设计语言
Bjarne Stroustrup / 裘宗燕 / 机械工业出版社 / 2010-3-1 / 99.00元
本书是在C++语言和程序设计领域具有深远影响、畅销不衰的著作,由C++语言的设计者编写,对C++语言进行了最全面、最权威的论述,覆盖标准C++以及由C++所支持的关键性编程技术和设计技术。本书英文原版一经面世,即引起业内人士的高度评价和热烈欢迎,先后被翻译成德、希、匈、西、荷、法、日、俄、中、韩等近20种语言,数以百万计的程序员从中获益,是无可取代的C++经典力作。 在本书英文原版面世10年......一起来看看 《C++程序设计语言》 这本书的介绍吧!