Sphinx开发¶
Sphinx由一群志愿者维护。我们重视每一个贡献!
- 该代码可以在Git存储库中找到,网址为https://github.com/sphinx-doc/sphinx/。
- 应该在 跟踪器 中提出问题和功能请求.
- 用于开发的邮件列表位于 Google Groups .
- freenode 上还有 #sphinx-doc IRC频道 .
有关我们的开发过程和方法的更多信息,请参阅 Sphinx开发人员指南.
扩展¶
要了解如何编写自己的扩展,请参阅 为Sphinx开发扩展。
sphinx-contrib 知识库包含许多贡献的扩展。其中一些在PyPI上有自己的版本,其他一些你可以从结帐安装。
这是该存储库中当前贡献的扩展列表:
- aafig:使用 aafigure 渲染嵌入式ASCII艺术作为漂亮的图像
- actdiag:使用 actdiag 嵌入活动图
- adadomain: Ada支持的扩展(需要Sphinx 1.0)
- ansi: 解析文档中的ANSI颜色序列
- argdoc: 自动生成命令行参数,描述和帮助文本的文档
- astah: 使用astah嵌入图表
- autoanysrc: 从任何源文件中收集reST文档
- autorun: 在
runblock
指令中执行代码 - blockdiag: 使用 blockdiag 嵌入框图
- cacoo: 从Cacoo嵌入图表
- cf3domain: CFEngine 3政策的域
- cheader: Sphinx的内置C域缺少 c:header 指令
- cheeseshop: 轻松链接到PyPI包
- clearquest: 从 ClearQuest 查询创建表
- cmakedomain: CMake 的域
- coffeedomain: (自动)记录CoffeeScript源代码的域
- context: ConTeXt的构建器
- disqus: 在文档中嵌入Disqus评论
- documentedlist: 将Python列表转换为生成的文档中的表
- doxylink: 链接到外部Doxygen生成的HTML文档
- domaintools: 一个轻松创建域的工具
- email: 混淆电子邮件地址
- erlangdomain: Erlang支持的扩展(需要Sphinx 1.0)
- exceltable: 使用 exceltable 将Excel电子表格嵌入到文档中
- feed: 用于从您的网站内容创建联合供稿和基于时间的概述的扩展程序
- findanything: 一个扩展,用于在文档中添加Sublime Text-like findanything面板,以便在键入时查找页面,节和索引条目
- gnuplot: 使用 gnuplot 语言生成图像
- googleanalytics: 使用 Google Analytics 跟踪网络访问者统计信息
- googlechart: 使用 Google Chart 嵌入图表
- googlemaps: 使用 谷歌地图 嵌入地图
- httpdomain: 用于记录RESTful HTTP API的域
- hyphenator: 使用连 hyphenator 的客户端HTML连字符
- imgur: 在文档中嵌入Imgur图像,相册和元数据
- inlinesyntaxhighlight: 内联语法高亮显示
- lassodomain: 用于记录 Lasso 源代码的域
- libreoffice:包含LibreOffice支持的任何绘图的扩展(例如odg,vsd,…)
- lilypond: 从 Lilypond 以PNG格式插入音乐脚本的扩展程序
- makedomain: GNU Make 的域
- matlabdomain: 文档 MATLAB 代码
- mockautodoc: 模拟进口
- mscgen: 嵌入mscgen格式的MSC(消息序列图)
- napoleon: 支持 Google style 和 NumPy style docstrings
- nicovideo: 嵌入来自nicovideo的视频
- nwdiag: 使用 nwdiag 嵌入网络图
- omegat: 支持与 OmegaT 协作的工具(需要Sphinx 1.1)
- osaka: 将标准日语文档转换为大阪方言(这是一个笑话扩展)
- paverutils: Sphinx与 Paver 的替代集成
- phpdomain: PHP支持的扩展
- plantuml: 使用 PlantUML 嵌入UML图
- py_directive: 在
py
指令中执行python代码并返回一个数学节点 - rawfiles: 复制原始文件,如CNAME
- requirements: 在任何需要的地方声明需求(例如在测试文档字符串中),标记状态并将它们收集在一个列表中
- restbuilder: reST(reStructuredText)文件的构建器
- rubydomain: Ruby支持的扩展(需要Sphinx 1.0)
- sadisplay: 显示SqlAlchemy模型 sadisplay
- sdedit: 使用快速序列图编辑器(sdedit)扩展插入序列图
- seqdiag: 使用 seqdiag 嵌入序列图
- slide: 在 slideshare 和其他网站上嵌入演示幻灯片
- swf: 嵌入flash文件
- sword: 从 Sword 插入圣经经文的扩展
- tikz: 使用 TikZ/PGF LaTeX package 绘制图片
- traclinks: 从Sphinx中创建 TracLinks 到 Trac 实例
- versioning: Sphinx扩展允许构建版本化文档以进行自托管
- whooshindex: whoosh的索引器扩展
- youtube: 从 YouTube 嵌入视频
- 提供一个
autointerface
指令,用于使用 Zope interfaces
在开始编写自己的扩展时,请参阅 extension tutorials 。