sphinx用法

介绍

Sphinx使用Python编写，最初为Python语言创建文档。可以使用sphinx编写文档、说明、书籍等。

安装

1. 安装python
2. 安装sphinx

http://jwch.sdut.edu.cn/book/tool/UseSphinx.html

easy_install sphinx

使用

1. 初始化：运行sphinx-quickstart(另外可以使用sphinx-apidoc)，按要求选择，也可以全部默认
2. 修改主题
   1. 在conf.py文件中修改html_theme = 'classic'
3. 编译
   1. 在项目根目录下执行make html
4. 加入markdown格式支持
5. 托管到read the docs