python资源大全|python用以生成项目文档的库
- 相关推荐
Sphinx:Python 文档生成器。
它最初是为Python文档,并且它具有以多种语言编写软件项目的优秀工具。当然,这个站点也是使用Sphinx从reStrucredText源创建的!应突出下列特点:
输出格式:HTML(包括WindowsHTML帮助),LaTeX(用于可打印的PDF版本),ePub,Textinfo,手册页,纯文本广泛的相互参照:函数、类、引文、术语表术语和类似信息的语义标记和自动链接等级结构:文档树的简单定义,自动链接到兄弟姐妹、父母和子女自动索引:通用索引以及特定于语言的模块索引。代码处理:使用俾格蒂荧光笔延期:代码片段的自动测试,包含Python模块(API文档)中的docstring,以及更多协助延期:50多个扩展用户贡献在第二个存储库中;其中大多数都可以从PyPI中安装。
MkDocs:对 Markdown 友好的文档生成器。
MkDocs是快速, 简约,用于构建项目文档的静态站点生成器。文档源文件是用Markdown编写的,并配置了一个YAML配置文件。
寄主在任何地方:MkDocs构建完全静态的HTML站点,可以在GitHub页面、AmazonS 3或任何地方否则你自己选。可供选择的伟大主题:有一堆好看的主题可用于MkDocs。在内置主题之间进行选择:mkdocs和读博士中的第三方主题之一。mkDocs wiki,或建立你自己的.当你工作时预览你的网站:内置的开发服务器允许您在编写文档时预览文档。当您保存更改时,它甚至会自动重新加载和刷新您的浏览器。易于定制:通过自定义主题,使项目文档看起来就像您想要的那样。
pdoc:可替换Epydoc 的库,自动生成 Python 库的 API 文档。
pdoc是一个库和一个命令行程序,用于发现Python模块或包的公共接口。这个pdoc脚本可用于生成模块公共接口的纯文本或HTML,也可用于运行为已安装模块提供生成的HTML的HTTP服务器。可以通过遍历抽象语法来查找模块、类和实例变量的文档字符串,从而支持记录数据表示。
Pycco
Pycco是docco的Python端口:以文学编程(literate-programming)风格的文档生成器。
以上4个python用以生成项目文档的库,有任何IT问题都欢迎问我~这里有一些我收集的资料想要的评.论!回复【资料】即可