Sphinx FAQ

このセクションでは、Sphinxについてよく聞かれる質問とその答えについてまとめています。新しいセクションを気軽に追加してください！

どのようにすれば...

... セクション番号を設定できますか？

LaTeX出力では自動的に設定されます。HTML出力では、 toctree ディレクティブに対して、ナンバリングをしたい位置に対して :numbered: オプションを付けると、設定することができます。

... ビルドするHTMLファイルの見た目をカスタマイズできますか？

HTMLテーマのサポート を読んで、テーマを利用すると、カスタマイズすることができます。

... すべてのドキュメントで置換を行ったり、インクルードできますか？

これらの定義を rst_epilog コンフィグ値を使って行ってください。

... 自分用のSphinx拡張を作成できますか？

Sphinx拡張チュートリアル をご覧ください。

... MoinMoinというWikiのマークアップで書かれた既存のドキュメントから変換できますか？

一番簡単の方法としてはレンダリング済みの xhtmlからreST に変換する方法でしょう。 見出しやコード例などがうまく変換できたとしても、クラスなどのマークアップはしなおす必要があるでしょう。

Sphinxと一緒に ... を使うには？

Epydoc

API ロール を提供するサードパーティ製の拡張機能があります。このロールは、与えられた識別子を持つ要素のEpydocのAPIドキュメントへの参照を行うことができます。

Doxygen

Michael Jones氏が reST/Sphinxからdoxygenへの橋渡しをする、 breathe というツールを開発しています。

SCons

Glenn Hutchings氏が、SphinxのドキュメントをビルドするためのSConsビルドスクリプトを作成しています。このスクリプトは、次のURLのところで開発されています: http://bitbucket.org/zondo/sphinx-scons

github pages

Michael Jones氏の sphinx-to-githubツール を使用すると、SphinxのHTML出力を、githubページにアップロードする用に書き換えを行います。