Sphinx 文档工具

Sphinx 文档工具

BSD
Python 查看源码»
跨平台
2009-07-29
红薯

Sphinx简单来说,是一个文档生成工具,用于把reStructuredText 格式的源文件生成诸如HTML, PDF, LaTex一类的格式。编辑者无须亲自处理文本的格式, 程序会自动根据源文件里的设置产生格式, 以及自动生成章节链接等工作。

和 DocBook一样,Sphinx可以看做是一个把文本格式处理和文字编辑分开的工具。举个例子来说吧,大家一定都曾有过上学时用Word痛苦地修改论文 的经验(没办法,在中国LaTex太小众),其中Word里面千奇百怪的可见或不可见的格式符、控制符一定玩弄了大家很久。而类似DocBook或 reStructuredText 一类的格式则完全采用文本文件来记录文字格式,各种格式控制字符完全可见,不会出现如Word里某个隐藏在段落末尾的莫名控制符导致文章之后的某些部分完 全乱掉,而完全找不到这个控制符的情况了。同时,完全采用纯文本文件进行记录,使得使用版本控制软件对编辑工作进行全程追踪和记录成为了可能。而最终通过 文本的源文件生成具有格式和样式的文本则完全是程序所进行的工作,避免了一切出错的可能。

使用Sphinx的项目有很多,著名的包括 Python , Django 的文档,全部是使用Sphinx 生成的。

的码云指数为
超过 的项目
加载中

评论(1)

暂无评论

Sphinx 1.4 发布,Python 开发程序文档工具

Python 开发的程序文档工具 —— Sphinx 发布 1.4 版本,Sphinx 简单来说,是一个文档生成工具,用于把reStructuredText 格式的源文件生成诸如HTML, PDF, LaTex一类的格式。编辑者无须亲自处...

2016/04/05 16:17

没有更多内容

加载失败,请刷新页面

没有更多内容

2
回答
Sphinx 文档工具的网友评论

Sphinx简单来说,是一个文档生成工具,用于把reStructuredText 格式的源文件生成诸如HTML, PDF, LaTex一类的格式。编辑者无...

2009/12/11 11:38

没有更多内容

加载失败,请刷新页面

没有更多内容

sphinx增量索引方案

在实际应用中往往有这么一种情况,数据库数据很大,比如我们的歌曲表,如果我们每次都去更新整个表的索引,对系统得开销将非常大,显然这是不合适,这时我们会发现,每天我们需要更新的数据相...

2016/01/06 16:39
87
0
Mysql+sphinx+中文分词简介

一、编译先前条件 确认是否已经安装以下软件,有些也许不是必须的,但建议还是都装上。 apt-get install autoconf automake autotools-dev cpp curl gawk gcc lftp libc6-dev linux-libc-dev ...

2012/07/06 16:00
435
1
pylint sphinx 使用

pylint 命令: python -m pylint 显示帮助: python -m pylint --help 将(默认)配置输出到标准输出: python -m pylint --generate-rcfile 指定检查使用的配置文件: python -m pylint --r...

2015/06/30 16:44
21
0
使用sphinx快速生成Python API 文档

不管是开源还是闭源,文档都是很重要的。当然理论上说,最好的文档就是代码本身,但是要让所有人都能读懂你的代码这太难了。所以我们要写文档。大部分情况,我们不希望维护一份代码再加上一份...

2015/03/06 09:49
1K
0
rst转为html

rst转为html

2018/05/02 13:51
65
0
编译ceph官网文档,输出为pdf格式

###编译过程: 以ubuntu系统为例: - 在ceph源码根目录/home/ceph-master执行./admin/build-doc。根据提示安装所有需要的依赖包,如: python-dev python-pip python-virtualenv doxygen dit...

2015/07/21 13:02
436
0
#sphinx#生成html文档

最近研究eventlet的资料,打开了官网文档(http://eventlet.net/doc/)但是不见得有下载。无奈windows安装sphinx无力。。。 于是跑去github找这个项目,因为windows上没安装git,只好下载项目...

2015/03/08 13:15
347
0
全文检索引擎Sphinx之初体验

Sphinx是一个开源的全文检索服务,支持实时检索,号称高性能、高可用、易扩展。

2013/08/12 19:17
303
1
Sphinx生成PDF

https://zh-sphinx-doc.readthedocs.io/en/latest/tutorial.html https://www.ibm.com/developerworks/cn/opensource/os-sphinx-documentation/ 1、安装Anaconda for python 2.7 √ 2、安装s...

2017/08/27 20:58
118
0

没有更多内容

加载失败,请刷新页面

返回顶部
顶部