标签:style blog http io ar color os 使用 sp
一.sphinx简介
Sphinx 是用 Python 编写的,并且最初是为 Python 语言文档而创建,默认情况下,Sphinx 会为 Python 突出显示代码,但它还允许定义其他编程语言,比如 C 和 Ruby。
有很多开源工程都采用sphinx作为文档生成系统,最有名的就是 python官方文档 。 在 sphinx官方 网站 上也列出使用sphinx的项目,有将近90个左右,其中不乏大名鼎鼎的开源项目。
一些中文的翻译项目也采用了sphinx,如 pymotwcn 。
二.sphinx的安装和配置
1. 安装python
2. 要确认已经安装了setuptools
3. 在命令行输入easy_install sphinx
建议使用sphinx自带的配置工具sphinx-quickstart。 - 建立一个工程目录,比如D\:Note。 - 在该目录启动命令行,输入sphinx-quickstart
D:\Note>sphinx-quickstart
程序会提示输入一些选项,如输入根目录等。大部分使用默认选项,直接按回车即可。
分离source和build目录,方便管理
指定工程名、作者名、版本号
* autodoc: automatically insert docstrings from modules (y/N) [n]: y
* viewcode: include links to the source code of documented Python objects (y/N) [n]:y
4. Be sure to create a makefile. It makes life simple.
基本完成了,使用make html命令就可以生成html形式的文档了。如果make html不行,可以使用这个命令:sphinx-build -b html source build
http://sphinx-doc-zh.readthedocs.org/en/latest/rest.html rst入门中文介绍
http://www.osseye.com/?p=239 sphinx实时索引架构现实
http://codinn.com/projects/sphinx/view/contents.htmlphinx使用手册
http://wowubuntu.com/restructuredtext-sphinx.html 文档与笔记利器 reStructuredText 和 Sphinx
http://www.cnblogs.com/Lvkun/archive/2010/04/01/1702245.html使用sphinx记笔记
http://notes.yeshiwei.com/sphinx.html
http://www.ibm.com/developerworks/cn/opensource/os-sphinx-documentation/使用 sphinx 制作简洁而又美观的文档
标签:style blog http io ar color os 使用 sp
原文地址:http://www.cnblogs.com/Bob-FD/p/4154719.html