Posts tagged with sphinx


Python有个自带的工具可以生成Python的项目文档叫pydoc,不过生成的 html 代码有一些丑陋不堪,看着有点杂乱,经常看到国外开源项目使用的 sphinx 文档很漂亮就在网上学习了一下生成方法,这里我们就讲一下python-Sphinx的使用。 Sphinx可以自动获取代码中的(''' ''' 注释),自动生成文档。 注意:此教程中,以工程根目录作为测试目录,实际使用中应该在文档目录中生成,请自行测试。 首先我们看一下生成效果 首先 我们要安装 sphinx pip install sphinx 安装 sphinx 主题 pip install sphinx_rtd_theme 在项目根目录运行…