下面是通过 mkdocs 运行它产生 readthedocs 主题页面后的最终结果(不包括函数注释)的示例。
我相信你已经知道,使用这些机制自动生成文档,会生成完整、精确和最新的模块信息,这些信息在你编写代码的时候可以进行维护和编写,且操作简单 。我强烈建议每个人都试一试。
在结束之前,我想再补充一点,mkdocs 并不是唯一的文档包,还有其他一些使用广泛的系统,如 Sphinx(mkdocs 基于此开发 )和 Doxygen,他们都能实现我们以上讨论的事项。然而,我比较通过练习来学习和了解更多关于 Python 内部机制和其随附的工具。