Sphinx

初めて作成したとき

、それが主な目的だと、Pythonの独自のコードのドキュメントジェネレータとして機能するようにしました。
それ以来、このプロジェクトは、言語に関係なく、周りのほとんどの自動ドキュメントジェネレータで最も参照の影響の一つである、開発の世界でカルトの状態に達しています。
今日、ちょうどPythonの他に、スフィンクスも同様にCおよびC ++コードで使用することができます。

このリリースで新しく追加されます：

C ++ドメインに便利なディレクティブとロールを追加します。ディレクティブ `` CPP：member``、役割 ``：： `` CPPの別名としてvar`` CPP： ``の別名としてvar``：CPP：member``、任意のC ++ declaractionへの相互参照用と役割 `any`。
：confval：​​ `source_suffix`設定値は、現在複数のサフィックスのリストになります。
confval：​​ `source_parsers`設定値とソースサフィックスによってソースパーサを指定する機能を追加します。
新しいビルダー、AppleHelpBuilderは、アップルのヘルプブックを作成しますが追加されました。

バージョン1.2.3 / 1.3b3の新機能です。

スフィンクスのバージョンのプログラムのチェックを追加しました `` sphinx.version_info``タプル。

バージョン1.1.3の新機能は次のとおりです。

confval：​​いくつかの設定を修正し、クラッシュ `modindex_common_prefix`。
`` -D``とPython 3の `` -A``オプションの処理を修正。
代わりに再帰エラーに実行するので、認識され、円形toctreesについて警告。
docutilsのトランクとの互換性を復元します。
HTMLヘルプのインデックスエントリのリンクが再び修正しました。
組み込みコマンドの属性エラーを発生させるinheritance_diagram修正しました。
用語集にコメントや孤立用語を入れたときにクラッシュを修正しました。
すべてのスフィンクスのための固定されたHTMLヘルプの言語/エンコーディングマッピングは言語をサポートしていました。

バージョン1.1の新機能は次のとおりです。

機能が追加されました：
Pythonの3.xのサポートが追加されました。
新しいビルダーとサブシステム。
互換性のない変更：
：RST：DIR： `PY：module`のディレクティブはもうその` `platform``オプション値出力しません。 （これは、ディレクティブが出力をしたので、非常に矛盾していることを唯一のものでした。）
古い依存関係のバージョンのサポートを削除しました。
新しいロケール：
スウェーデン語ロケールを追加しました。
イランのロケールを追加しました。
ラトビアロケールを追加しました。
ネパール語ロケールを追加しました。
韓国ロケールが追加されました。
エストニア語ロケールを追加しました。

バージョン1.0.8の新機能は次のとおりです。

自動サマリー世代のAttributeErrorsためのトレースバックを修正しました。
略語がそれに改行を持っている場合、 `` abbr``役割を修正しました。
カスタム·オブジェクト·タイプの検索結果にリンクを修正しました。
未定義の参照に関する警告で報告された行番号を修正しました。
C ++配列定義と名前を入力していないテンプレート引数を修正しました。
LaTeX出力のセクションヘッダ内の脚注を許可します。
キーワードはintersphinxを介して連結されることを可能にします。
生産リストトークン名にUnicode文字を許可します。
テキストと男性のためのgraphvizのノード用のダミーの訪問者を追加します。
画像ファイルの複製のバグを修正しました。
C ++ドメインで複数の署名の解析を修正。
ソースファイルを探すときにEmacsのロックファイルを無視します。
autodocのでインポート可能なモジュールの.pyw拡張を可能にします。
クイックスタートで生成されたメークファイルに `` $（MAKE）を使用します。
ブラウザで一貫性のあるサイドバーの検索ボックスの幅を行います。
HTML出力で中心人物の間隔を修正しました。
sys.stderrにするためにそれらを印刷する際の安全SphinxErrorメッセージのエンコード。
セクションのない文書が、リンク先でLaTeXの出力誤差を修正しました。
正しくautodocの中のメソッドとして組み込みメソッドの記述子を扱います。
Pythonのtextwrapモジュールをmonkeypatching停止します。
Viewcodeは現在、非ASCIIエンコーディングを持つソースファイルで正常に動作します。
モジュールディレクティブ：PYで `` noindex``フラグオプションを尊重します。
RST：DIR： `literalinclude`で存在しない行を含むときIndexErrorsを修正しました。
尊重カスタム関数/メソッドのパラメータの区切り文字列。
jQueryの＆GTとJSの非互換性を修正し、1.5を=。
HTMLヘルプ.hhkファイルを書き込むときに行われ、二重エンコーディングを修正しました。
解析されたリテラルブロックでSmartyPantsを与えないでください。
C ++ドメインは現在、配列定義をサポートしています。

バージョン1.0.6の新機能は次のとおりです。

空のクロスリファレンスターゲット用のPythonドメインのトレースバックを修正しました。
Chromeのブラウザでリテラルブロック表示の問題を修正しました。
一般的なインデックスや用語集のアクセント付き文字の制限された範囲をソートするサポート。
ロケールの優先エンコーディングを持つ `` `-D``と` -A``コマンドライン引数をデコードしてみてください。
観察：confval：​​ `locale_dirs` JSの翻訳ファイルを探すとき。
LaTeXのビルダーでの日本語のドキュメントのより良いサポートのための特別なコードを追加します。
＃77の後退は：PARAM：： ``で与えられた唯一の1つのパラメータが存在する場合、 ``マークアップは、弾丸リストを再度抑制されています。
特定の状況においてLaTeXの出力に不足している段落の区切りを修正しました。
それは、コンテンツを追加できるようにドキュメント文字列がなくてもオブジェクトの `` autodocのプロセス-docstring``イベントを発します。
LaTeXのビルダーでは、だけではなく、リテラルブロックは、別のテーブルの処理を必要とするだけでなく、かなりの数の他のリストのようなブロック要素。
有効な署名がないPythonのオブジェクトのviewcode拡張にトレースバックを修正しました。
docutilsのバージョンに応じて異なる挙動によるaut​​odocの-含まドキュメンテーション文字列から生成された警告用の行番号の奇妙なreportingsを修正しました。
C ++ドメインにいくつかの修正。

バージョン1.0.5の新機能は次のとおりです。

整列した画像や図形のためのdocutils 0.7で必要とされるCSSスタイルを追加します。
LaTeX出力で生成されたMakefileで、きれいにpdfファイルを削除しないでください。彼らは、必要なイメージかもしれません。
ラインブロックに対して生成されたLaTeX出力を修正しました。
許可 ``ソースファイルの拡張子として.pyw``。

バージョン1.0.4の新機能は次のとおりです。

バージョン2はZLIB圧縮データが含まれているので、Windowsでバイナリモードでオープンintersphinx目録、。
JavaScriptファイル、例えばのために非ローカルURIを与え許可しますのjsMath拡張の。
`` intersphinx_mapping``が空のときにトレースバックを修正しました。

バージョン1.0.3の新機能は次のとおりです。

のdocutilsの目次からのリンクのための内部対外部リンクの区別を修正しました。
``崩壊= True``ので使用した場合、 `` toctree（） ``テンプレート呼び出し可能のための `` maxdepth``オプションを修正しました。
文字列リテラル内のブラケットを含むPythonの引数リストを解析クラッシュする問題を修正しました。
キャプションを持っていない図面とLaTeXのドキュメントを構築する際の回帰を修正しました。
pickle化可能なではないクラスの継承図を修正しました。
それが簡単に参照すること、サイドバーの崩壊ボタンに個別の背景色をご紹介します。
いくつかの組み込みのテーマで小さなレイアウトのバグを修正しました。

バージョン1.0.2の新機能は次のとおりです。

FUNC： `〜.Sphinx.add_object_type` API関数によって追加された型のオブジェクトへの相互参照を修正しました。
別のディレクティブ·タイプのドキュメントのフィールドタイプの扱いを修正しました。
バックラッシュエスケープ改行を続けると、長い署名を破ることができます。
（理由Pygmentsのスタイルで名前空間の衝突の）Cドメイン参照の不要なスタイリングを修正しました。
明示的なアンカーとのPEPおよびRFCへの参照を許可します。
図をLaTeXの参照を修正しました。
非正確な検索を行うと、オブジェクトの唯一の指定された型と一致しています。
あまりにモジュールの `` .name``でPythonの基準ターゲットの非正確な検索を適用します。
infoフィールドリストのパラメータを複製する際にクラッシュする問題を修正しました。
`` oldcmarkup``拡張モジュールが提供するものにデフォルトのロールを設定修正。
JSON-PYがインストールされているときにクラッシュする問題を修正し、 `` json``モジュールを提供しますが、のsimplejsonに非互換です。
intersphinxでターゲットの命名の扱いを修正しました。
``の除去を修正する！ ``すべての相互参照の役割のために。

バージョン1.0.1の新機能は次のとおりです。

reSTのドメインオブジェクトの生成されたターゲット名を修正しました。それらは同じ名前空間にはありません。
ベンガル語を追加します。
JavaScriptオブジェクト名を解析のバグを修正しました。
何toctreeがないときSingleHTMLBuilder付の建物修正しました。
明確な目標にintersphinxによってリンクされたオブジェクトの表示名を修正しました。
JSONビルダーでビルド修正しました。
LaTeXのためのオブジェクト記述でhyperrefsを修正しました。

バージョン1.0の新機能は次のとおりです。

一般：
不足しているすべての参照のための警告を発する「せこい」モードが追加されました。オプション： `-n`コマンドラインスイッチまたは：confval：​​` nitpicky`設定値これは、によって活性化されます。
クイックスタートMakefileで `` latexpdf``ターゲットを追加しました。
マークアップ：
：RST：ロール： `menuselection`と：RST：ロール：` guilabel`役割は今アンパサンドアクセラレータをサポートしています。
新しい、よりコンパクトなドキュメント·フィールドの構文が認識されます。 ``：PARAM型名：description``を。
RST：に追加しました ``タブwidth``オプションDIR： `literalinclude`ディレクティブ。
RST：DIR： `toctree`ディレクティブを追加しました` `titlesonly``オプション。
RST：DIR： `literalinclude`ディレクティブ` `prepend``とに` `append``オプションが追加されました。
すべてのDOCINFOのメタデータは、ドキュメントのメタデータだけではなく、作者に置かれました。
：RST：ロール： `ref`役割は今もキャプションによってテーブルを参照することができます。
：RST：DIR： `include`ディレクティブは、現在のソースディレクトリからの相対パスとして解釈されている絶対パスをサポートしています。
Pythonのドメインでは、 ``のような参考文献：FUNC： `.name```は今は直接の一致が見つからない場合は、任意の接頭辞で名前を一致探します。
構成：
追加：confval：​​ `rst_prolog`設定値。
追加：confval：​​ `セクションの番号形式を制御するhtml_secnumber_suffix`の設定値。
追加：confval：​​ `のdocutils「コンパクトなリストを備えています制御するhtml_compact_lists`設定値。
：confval：​​ `html_sidebars`設定値は、現在のキーとしてのパターンを含むことができ、その値を明示的にテンプレートがレンダリングされるべきサイドバーを選択リストすることができます。つまり、組み込みサイドバーコンテンツのみを選択的に含めることができることを意味します。
：confval：​​ `html_static_path`は今単一ファイルのエントリを含めることができます。
新しいユニバーサル設定値：confval：​​confval：​​ `unused_docs`、：confval：​​` exclude_trees`と：confval：​​廃止された `` exclude_dirnames` exclude_patterns`は古いします。
追加：confval：​​ `html_output_encoding`設定値。
confval：​​追加された `latex_docclass`設定値をと「片側」によってオーバーライド」twoside」documentclassのオプションを作りました。
confval：​​ `trim_doctest_flags`設定値は、デフォルトでtrueになって追加されました。
追加：confval：​​ `html_show_copyright`設定値。
追加：confval：​​ `latex_show_pagerefs`と：confval：​​` latex_show_urls`設定値。
confval：​​の挙動は `html_file_suffix`は若干変更：空の文字列になりました代わりに、「デフォルトの接尾辞」の「接尾辞」、「デフォルトの接尾辞」のための使用` `None``でないことを意味します。
新しいビルダー：
EPUBフォーマットのビルダーを追加しました。
マニュアルページのためのビルダーを追加しました。
単一ファイルのHTMLビルダーを追加しました。
HTML出力：
インライン役割は今のスタイルが彼らの外観をカスタマイズすることができ、自分の名前でCSSクラスを取得します。ドメイン固有の役割は、2つのクラス、 `` domain``と ``ドメインrolename``を取得します。
現在のページへの内部とは対照的に、彼らは、プロジェクト全体の内部にある場合の参照は、この時点ではクラス `` internal``を取得します。
外部参照は、デフォルトのテーマのための新しい `` externalrefs``テーマオプションで異なるスタイルすることができます。
デフォルトのテーマでは、サイドバーは、実験的に新しい `` collapsiblesidebar``テーマオプションを使用して折りたたみ可能にすることができます。
Toctreesは現在、HTML出力内のクラスと `` div``タグ `` toctree-wrapper``に包まれています。
：データ： `テンプレートで呼び出し可能toctree`は今、生成木の深さを制御するために、` `maxdepth``キーワード引数を持っています。
：データ： `テンプレートで呼び出し可能toctree`今` `titles_only``キーワード引数を受け入れます。
レイアウトテンプレートに追加された `` htmltitle``ブロック。
JavaScriptの検索では、 `` sys.argv``ように、モジュール名などのオブジェクト名を検索することができます。
俳句OSのユーザーガイドに触発された新しいテーマ `` haiku``を、追加しました。
新しいテーマ `` nature``を追加しました。
アンディアルブレヒトによって作成された新しいテーマ `` agogo``は、追加されました。
アーミンRonacherによって作成された新しいテーマ `` scrolls``は、追加されました。
デフォルトのテーマに `` visitedlinkcolor``テーマオプションが追加されました。
非同期thesearchインデックスをロードすることによって、検索ページの応答性を改善しました。
拡張API：
追加：イベント： `HTMLコレクト-pages`。
追加：confval：​​ `needs_sphinx`設定値と：メタ：`〜sphinx.application.Sphinx.require_sphinx`アプリケーションAPIメソッド。
追加：メタ： `〜sphinx.application.Sphinx.add_stylesheet`アプリケーションAPIメソッド。
拡張機能：
MOD： `〜sphinx.ext.viewcode`拡張子が追加されました。
MOD： `〜sphinx.ext.extlinks`拡張子が追加されました。
bysource'`` = '`` autodoc_member_orderで、autodocの中のメンバーの元の順序のサポートが追加されました。
追加：confval：​​ `autodoc_default_flags`設定値、すべてのautodocのディレクティブのデフォルトのフラグを選択するために使用することができます。
intersphinxは他のプロジェクトで名前のラベルを参照すると、リンク先にするプロジェクトを指定するための方法を追加しました。
autodocのは今 `` __init__``方法で割り当てられたインスタンスの属性を記録することができます。
に対する多くの改善と修正：MOD： `〜sphinx.ext.autosummary`拡張、パウリビルタネンのおかげ。
`graphviz_output_format`設定値：MOD：confvalによって制御される代わりに、PNGイメージの`〜sphinx.ext.graphviz`拡張子を出力できるようになりましたSVG、。
RST：に追加しました `` alt``オプションDIR： `graphviz`拡張ディレクティブ。
FUNC：に追加しました `` exclude``引数 `.autodoc.between`。
翻訳：
、ボヤンMihelacのおかげでクロアチア語の翻訳を追加しました。
、Firat Ozgulのおかげでトルコ語翻訳を追加しました。
カタロニア語翻訳は、ポーフェルナンデスのおかげで追加されました。
簡体字中国語の翻訳が追加されました。
、Hjorthラーセンのおかげでデンマーク語の翻訳を追加しました。
、Dalius Dobravolskasのおかげでリトアニア語の翻訳を追加しました。

どのバージョン1.0b1で新しく追加されます：

ドメインのサポートが追加されました。ドメインは、ディレクティブと、すべてのオブジェクトは、例えば、一緒に属する記述役割の集合ですプログラミング言語の要素。いくつかの組み込みのドメインが提供されています： - Pythonの - C - C ++ - JavaScriptの - reStructuredTextの
Cディレクティブに定義し、リンクするための古いマークアップは、 `` oldcmarkup``拡張子を活性化することなく、もはや動作しません。
古い依存関係のバージョンのサポートを削除しました。
非推奨の要素を削除しました。

バージョン0.6.5の新機能は次のとおりです。

autodocのでは、明示的にドキュメントコメントを使用して文書化し、いくつかのモジュール部材の抜けを修正します。
デフォルトのテーマの `` stickysidebar``オプションでサイドバーのスクロールバーのトリミングを修正しました。
常にクイックスタートMakefileのUNIXの改行を生成します。
Windowsで-C`` ``で実行して修正しました。
autodocのでは、組み込みのメカニズムが失敗したオブジェクトの署名をカスタマイズすることができます。
ラテックス中の開始値と列挙リストの出力を修正しました。
一緒に使用されていない場合は正常に `` literalinclude``ディレクティブの仕事に ``開始after``と ``エンドbefore``オプションを作成します。
LaTeXのビルダーでリンク生成を修正しました。

バージョン0.6.4の新機能は次のとおりです。

構成内の非Unicode文字列の処理を改善しました。
それは理解していない引数を指定してgraphvizのを呼び出すときに発生するキャッチOSErrors。
Pygments＆GTとの互換性を復元し、1.2を=。
LaTeX出力にhyperrefターゲットのエスケープを修正しました。
DOC：LaTeX出力のための `` ``役割によって生成されたリンクを修正しました。
文書全体が読み込まれた後TODOノードを収集し、これは、TODO項目に置換参照を配置することができます。
LaTeXのビルドで明示的に `` today``の設定値を無視しないでください。
継承図の `` alt``テキストは非常にクリーンです。
リンクのキャプションを生成する際にセクションタイトルの画像を無視します。
`` doctest``拡張の `` testoutput``ブロックでサポート例外メッセージ。
ラインブロックは、HTML出力で適切にスタイルされています。
もう一度 `` locale_dirs``設定値の仕事をしました。
`` ``を介して、コマンドラインで指定html_context``値は-A``はconf.py.に与えられた他の値を上書きしないでください
`` dirhtml`` Builderの増分再構築を防止するバグを修正しました。
いくつかのリテラルブロックで引用符のマングリングを修正しました。
`` dirhtml`` Builderの検索インデックスへのパスを修正しました。
Jythonの互換性の問題を修正：オプションの `` parser``モジュールの依存を作ります。
autodocのでは、モジュールのインポートだけではなく、 `` ImportError``で発生するすべてのエラーをキャッチします。
autodocの中の非データの取り扱いが、非法の記述子を修正しました。
ファイルの時刻をコピーする場合、 `` os.utime（） ``が提起したOSErrorsを無視します。

要件：

Pygments 1.2以上
神社2.3以上
docutilsの0/7以上