Sphinxの開発

Sphinxはボランティアグループによって開発されています。私たちは、すべての貢献を歓迎します!

開発プロセスについては、 Sphinx開発者のためのガイド を参照してください。

拡張

自分で拡張を書く方法を知りたいときは、 Sphinx拡張機能の開発 をご覧ください。

sphinx-contrib リポジトリは寄贈されたたくさんの拡張を含んでいます。いくつかの拡張はPyPI上に独自にリリースされており、またその他のものはチェックアウトしてインストール出来ます。

これはリポジトリに含まれている寄贈された拡張の現在のリストです:

  • aafig: aafigure を使い、素晴らしい画像としてASCIIアートを埋め込みます。

  • actdiag: actdiag を使ってアクティビティ図を埋め込みます。

  • adadomain: Adaサポートの拡張です (Sphinx 1.0が必要です)。

  • ansi: ドキュメント中のANSIカラーシーケンスをパースします。

  • autorun: runblock ディレクティブ内のコードを実行します。

  • blockdiag: blockdiag を使ってブロック図を埋め込みます。

  • cheeseshop: PyPIパッケージへのリンクを簡単に作成出来ます。

  • clearquest: ClearQuest クエリーを使ってテーブルを作成します。

  • cmakedomain: CMakeのドメイン

  • coffeedomain: CoffeeScriptソースコードを(自動で)ドキュメントするドメインです。

  • context: ConTeXtのためのビルダーです。

  • doxylink: Doxygenが生成した外部のHTMLドキュメントへのリンクを作成します。

  • domaintools: 簡便なドメイン作成用ツール

  • email: メールアドレスを難読化します。

  • erlangdomain: Erlangサポートの拡張です (Sphinx 1.0が必要です)。

  • exceltable: exceltable を使い、Excelスプレッドシートをドキュメントに埋め込みます。

  • フィード: 時間ベースでサイトのコンテンツから概要を作成して配信フィードを生成する拡張です。

  • findanything: Sublime Text 2のようなfindanythingパネルを、タイプしながらドキュメントのfind,section, 及びindexエントリーに追加できるエクステンションです。

  • gnuplot: gnuplot を使って画像を生成します。

  • googleanalytics: Google Analytics を使ってwebの訪問者を追跡します。

  • googlechart: Google Chart を使ってチャートを埋め込みます。

  • googlemaps: Google Maps を使って地図を埋め込みます。

  • httpdomain: RESTful HTTP APIをドキュメント化するドメインです。

  • hyphenator: hyphenator を使ってHTMLをクライアント側でハイフネーションを行います。

  • inlinesyntaxhighlight: インラインのシンタックスハイライト

  • lassodomain: Lasso source codeをドキュメントするためのドメインです。

  • libreoffice: an extension to include any drawing supported by LibreOfficeでサポートされている描画(例: odg, vsd)を取り込むエクステンションです。

  • lilypond: Lilypond を使って楽譜をPNG画像として挿入する拡張です。

  • makedomain: `GNU Make`のためのドメイン_

  • matlabdomain: MATLAB コードをドキュメントするためのドメイン

  • mockautodoc: インポートのモック

  • mscgen: mscgen形式のMSC (Message Sequence Chart) を埋め込みます。

  • napoleon: Google styleNumPy style のdocstringsをサポートします。

  • nicovideo: ニコニコ動画から動画を埋め込みます。

  • nwdiag: nwdiag を使ってネットワーク図を埋め込みます。

  • omegat: OmegaT との連携をサポートするツールです(Sphinx 1.1 が必要です)。

  • osaka: 日本語の標準語を大阪弁に変換します(ジョーク拡張です)。

  • paverutils: Paver とSphinxの別の連携を行います。

  • phpdomain: PHPサポートの拡張です。

  • plantuml: PlantUML を使ってUMLダイアグラムを埋め込みます。

  • py_directive: Pythonコードを”py”ディレクティブで実行し、Mathノードを返す。

  • rawfiles: CNAMEのように元のファイルをコピーします。

  • requirements: 必要なところにrequirementsを記載して(例えばテストのdocstringで)、記載した内容とステータスを1つのリストにまとめて出力する拡張です。

  • restbuilder: reST (reStructuredText) ファイルに対するビルダー

  • rubydomain: Rubyサポートの拡張です (Sphinx 1.0が必要です)。

  • sadisplay: sadisplay モデルのSqlAlchemyを表示します。

  • sdedit: Quick Sequence Diagram Editor (sdedit) を使って、シーケンス図を挿入する拡張です。

  • seqdiag: seqdiag を使ってシーケンス図を埋め込みます。

  • slide: slideshare や他のサイトのプレゼンスライドを埋め込みます。

  • swf: Flashを埋め込みます。

  • sword: Sword からBible versesを埋め込む拡張です。

  • tikz: TikZ/PGF LaTeX package を使って絵を書きます。

  • traclinks: Sphinxから Trac インスタンスへの TracLinks を作成します。

  • whooshindex: whooshのインデクサー拡張です。

  • youtube: YouTube から動画を埋め込みます。

  • zopeext: Zope interfaces を使って autointerface ディレクティブを提供します。

自分で拡張を書くには、 Sphinx拡張チュートリアル をご覧ください。