Sphinx发育¶
Sphinx是由一群志愿者维持的。我们重视每一项贡献!
代码可以在git存储库中找到,网址为https://github.com/sphinx-doc/sphinx/。
问题和功能请求应在 tracker .
开发邮件列表位于 Google Groups .
还有Sphinx Doc IRC频道 freenode .
有关我们的开发过程和方法的更多信息,请参阅 Sphinx 内部构件 .
扩展¶
要了解如何编写自己的扩展名,请参见 发展Sphinx的延伸 .
这个 sphinx-contrib 存储库包含许多已贡献的扩展。其中一些版本在pypi上有自己的版本,另一些版本可以从签出处安装。
这是该存储库中已贡献扩展的当前列表:
actdiag:使用actdiag嵌入活动图
adadomain:ADA支持的扩展(需要sphinx 1.0)
ansi:分析文档中的ansi颜色序列
argDoc:自动为命令行参数、说明和帮助文本生成文档
astah:使用astah嵌入图表
autoanysrc:从任何源文件收集REST文档
自动运行:在
runblock
指令束流器:束流器( Latex )输出的生成器。
blockdiag:使用blockdiag嵌入框图
cacoo:从cacoo嵌入图表
cf3domain:cfengine 3策略的域
c header:sphinx的内置C域缺少c:header指令
奶酪店:轻松链接到pypi包
ClearQuest:从创建表 ClearQuest 查询
coffeedomain:用于(自动)记录coffeeesccript源代码的域
上下文:上下文的生成器
Disqus:在文档中嵌入Disqus注释
documentedlist:将python列表转换为生成的文档中的表
DoxyLink:指向外部Doxygen生成的HTML文档的链接
域工具:用于轻松创建域的工具
电子邮件:混淆电子邮件地址
ErlangDomain:Erlang支持的扩展(需要sphinx 1.0)
feed:用于从网站内容创建联合源和基于时间的概述的扩展
findanything:在文档中添加类似findanything面板的出色文本的扩展,以便在键入时查找页面、节和索引项
gnuplot:使用 gnuplot 语言
googleanalytics:使用 Google Analytics
GoogleChart:使用嵌入图表 Google Chart
谷歌地图:通过使用嵌入地图 Google Maps
http domain:用于记录RESTful HTTP API的域
断字器:使用断字器的HTML客户端断字
imgur:在文档中嵌入imgur图像、相册和元数据
inlineSyntaxHighlight_u:inline语法突出显示
lassodomain:用于记录的域 Lasso 源代码
libreoffice:包含libreoffice支持的任何绘图的扩展(例如odg、vsd等)
lilypond:插入音乐脚本的扩展 Lilypond 在PNG格式中
makedomain:的域 GNU Make
MatlabDomain:文档 MATLAB 代码
MockAutoDoc:模拟导入
mscgen:嵌入mscgen格式的msc(消息序列图)s
拿破仑:支持 Google style 和 NumPy style 文档字符串
nicovideo:嵌入nicovideo的视频
nwdiag:使用nwdiag嵌入网络图
OmegaT:支持与之协作的工具 OmegaT (需要Sphinx1.1)
大阪:将标准日语文档转换为大阪方言(这是一个笑话扩展)
摊铺机:Sphinx与摊铺机的交替集成
phpdomain:php支持的扩展
PlantUML:使用PlantUML嵌入UML图
py_指令:在
py
指令并返回一个数学节点raw files:复制原始文件,如cname
需求:在任何需要的地方声明需求(例如在测试文档字符串中),标记状态并将其收集到一个列表中
rest builder:rest(restructuredtext)文件的生成器
rubydomain:ruby支持的扩展(需要sphinx 1.0)
SDedit:使用快速序列图编辑器的扩展插入序列图 (sdedit)
seqdiag:使用seqdiag嵌入序列图
幻灯片:嵌入演示文稿幻灯片 slideshare 及其他网站
swf_uu:嵌入闪存文件
tikz:用 TikZ/PGF LaTeX package
版本控制:sphinx扩展,允许构建版本控制的文档进行自我托管
whooshindex:whoosh索引器扩展
zopeext:提供
autointerface
使用说明 Zope interfaces
见 extension tutorials 开始编写自己的扩展名。