使用sphinx快速生成文档

参考

Quick Sphinx documentation for Python

要点总结

project – docs – project

  1. 项目基要上有docs

sphinx-apidoc -F -o docs

  1. 使用sphinx-apidoc生成文档后要修改docs下的conf.py文件

sys.path.insert(0, os.path.abspath('../../sphinxy'))

  1. 在docs文档下, 使用make 生成所要的东西
Loading Disqus comments...
Table of Contents