功能特点
· 输出格式:HTML(包括Windows HTML帮助),LaTeX(用于可打印的PDF版本),ePub,Texinfo,手册页,纯文本
-
可扩展的交叉引用:为函数,类,引文,词汇术语等信息自动创建语义标记和链接
-
分层结构:很方便定义文档的树状结构,自动链接同级和下级文档
-
自动索引:支持一般索引和特定语言模块索引
-
代码处理:使用Pygments库自动对代码进行高亮显示
-
扩展:自动检测代码片段,包含来自Python模块的docstring(API文档)等
-
社区扩展:超过50个用户贡献的扩展,其中大多数可以通过PyPI安装
安装
用pip安装Sphinx:
$ pip install Sphinx
使用示例
创建文档目录及默认配置文件conf.py:
$ sphinx-quickstart