2020 Python 计算生态六月推荐榜
20年6月10日 · Python123 4591 人阅读
看见更大的世界,遇见更好的自己See a better world to meet better for ourselves.
要问程序员最不喜欢做什么,写文档一定榜上有名。文档对软件开发的重要性毋庸置疑,文档就是软件系统的持续生命力。对于开源项目或开放系统,文档是与程序员交流的入口,比代码更具价值。然而,文档维护却令人头疼,甚至抓狂,这源于程序员对代码的偏爱。如何调和文档重要性与程序员偏爱的矛盾呢?这难不倒我们,自动化文档工具快来了解一下!
2020年6月,为了帮助 Python 程序员编写出优质可靠、文档丰富、童叟无欺的 Python 项目,好事者在Python计算生态中特别推荐 10 款优秀的 自动化文档工具,帮助广大程序员轻松生成清晰优雅的项目文档,优美也可以自在!
Sphinx
Sphinx 是一种文档工具,它可以令人轻松的撰写出清晰且优美的文档,由
Georg Brandl 在BSD
许可证下开发。 新版的Python文档就是由Sphinx生成的。
https://www.sphinx-doc.org/en/latest/
portray
portray是Python3命令行工具和库,可以帮助你用尽可能少的努力尽可能为您的Python项目建立文档站点。
https://github.com/timothycrosley/portray
Python Handout
使用Markdown注释和嵌入式数字将Python脚本转换为讲义。支持任何文本编辑器的无隐藏状态的Jupyter笔记本的替代产品。
https://github.com/danijar/handout
MkDocs
MkDocs是一个快速,简单,完整的华丽静态站点生成器,专门用于构建项目文档。文档源文件使用Markdown编写,并使用单个YAML配置文件进行配置。
readthedocs
一个基于
Sphinx/MkDocs 的在线文档托管系统,对开源项目免费开放使用。
https://github.com/readthedocs/readthedocs.org
pdoc
一个可以替换
Epydoc 的库,可以自动生成
Python 库的
API 文档。
https://github.com/mitmproxy/pdoc
Pycco
文学编程风格的文档生成器。
https://github.com/pycco-docs/pycco
sphinx-click
sphinx-click是一个Sphinx插件,允许您从基于单击的应用程序中自动提取文档,并将其包含在文档中。
https://pypi.org/project/sphinx-click/
sphinx-automodapi
这是一个Sphinx扩展,可以自动为整个模块生成API页面。它最初是为Astropy项目开发的,但现在可以作为独立程序包使用,因为它可以用于任何其他程序包。
https://github.com/yoloseem/awesome-sphinxdoc
awesome-sphinxdoc
精选的Sphinx额外库,软件和资源列表。
Python3Turtle