安装 Sphinx
$ easy_install sphinx
Searching for sphinx
Reading http://pypi.python.org/simple/sphinx/
Reading http://sphinx.pocoo.org/
Best match: Sphinx 1.0.
Downloading http://pypi.python.org/packages/[...]
Processing Sphinx-1.0.-py2..egg
[...]
Finished processing dependencies for sphinx

脚本 sphinx-build 用来建立Sphinx文档集. 调用方式:

$ sphinx-build [options] sourcedir builddir [filenames]

调用示例:

$ sphinx-build -b html /home/ccx/user_docs/source/ /var/www/html/user_docs

sourcedir 是源文件目录 source directory , builddir 是生成文件目录.一般不需要写 filenames .

脚本 sphinx-build 的选项:

-b 生成器名字

生成器,决定了生成文档的类型,是最重要的选项. 通用的生成器有:

html

生成HTML文档. 默认的生成器.

最新文章

  1. redis成长之路——(五)
  2. Fiddler (四) 实现手机的抓包
  3. 苹果App Store审核指南中文翻译(2014.9.1更新)
  4. SQLite数据操作
  5. QQ音乐的各种相关API
  6. 工作流学习——Activiti流程定义管理三步曲 (zhuan)
  7. 文件系统取证分析(第11章:NTFS概念)
  8. [CSS3] 学习笔记-CSS入门基本知识
  9. Spring学习(1)----入门学习(附spring-framework下载地址)
  10. dSYM文件分析
  11. Android破解学习之路(三)——Android游戏 切水果破解
  12. poj Minimum( CutStoer Wagner算法)
  13. Java生成全局唯一ID代码演示
  14. 机器学习方法、距离度量、K_Means
  15. python中时间、日期、时间戳的转换
  16. TerraGate SFS Manager配置时权限设置问题
  17. Vijos1906 联合权值 NOIP2014Day1T2 树形动态规划
  18. ctrl c 中文字符到 vnc 里,中文字符已经被转码
  19. flex布局 响应式布局
  20. SharePoint 修改项目的new图标显示天数

热门文章

  1. MySQLD 配置
  2. windows中使用Git工具连接GitHub(配置篇)
  3. SPOJ 705 Distinct Substrings(后缀数组)
  4. Checking Network Configuration requirements Failed
  5. Android项目中包名的改动
  6. poj 2480 (欧拉函数应用)
  7. c/c++处理参数
  8. Linux下并发网络设计之I/O复用
  9. HTML5入门(一)
  10. ftp读取txt数据并插入数据库