Sphinx 1.1¶

リリース 1.1.3 (2012 年 3 月 10 日)¶

PR#40: safe_repr 機能の修復。これにより非アスキー文字によるバイト列と文字列を正しくデコードできます。
PR#37: sphinx-apidoc のコンフィグが SPHINX_APIDOC_OPTIONS により可能となります。
PR#34: Python 2.4 に対する互換性の回復
PR#36: 特定のドキュメントクラスの LaTeX 出力での "参考文献の目次への追加" を修正
#695: "python" の文字がはっきりとハイライトされている場合は、非Pythonであるととらえて、構文解釈はしないでください。
#859: リンク対象の適切なオブジェクトが見つからない場合に起きる例外を修正。
#860: 不正なdoctest例があってもクラッシュしないようになりました。単に警告が出るだけになります。
#864: Fix crash with some settings of modindex_common_prefix.
#862: Puthon 3における -D および -A オプションのハンドリングを修復。
#851: 循環しているtoctreeを検知し、再帰エラーとなるのではなく警告を発するようになりました。
#853: Restore compatibility with Docutils trunk.
#852: HtmlHelpインデックスエントリーのリンクを再度修正しました。
#854: 組み込みのinheritance_diagramが属性エラーを発生する問題を修正しました。
#832: 用語集でコメントまたは単独の用語があった場合にクラッシュする問題を修正しました。
#834, #818: Sphinx がサポートする全ての言語での HTML help での言語/エンコーディングマップの修正
#844: doctest 拡張で Unicode 出力を扱う際にクラッシュする問題を修正
#831: ヘルプに表示しているとおりにsetup_commandに --project フラグを追加
#875: Python 3 で config ファイルの読み取りを修正。
#876: Python 3 でクイックスタートテストを修正。
#870: ドキュメントを削除するときに嘘のKeyErrorが出る問題を修正しました。
#892: single-HTML ビルダーが、マスタードキュメントがサブディレクトリにある場合に誤った動作を行っていたのを修正。
#873: 空の only ディレクティブがあった場合にエラーとなる問題を修正しました。
#816: Qt ヘルプビルダーでエンコードの問題を修正しました。

リリース 1.1.2 (2011 年 11 月 1 日） - とにかく1.1.1 はバカなバージョンでした!¶

#809: ソース配布物にカスタムフィクサーを含めました。

リリース 1.1.1 (2011 年 11 月 1 日)¶

#791: QtHelp、DevHelp、HtmlHelp の索引エントリーへのリンクを修正しました。
#792: "sphinx-apidoc"をソース配布物に含めました。
#797: 不正な形式の用語集でクラッシュしないようになりました。
#801: SSLサポートがない場合でもintersphinが正しく動作するようになりました。
#805: 'Sphinx.add_index_to_domain' メソッドが正しく動作するようになりました。
#780: Python 2.5 の互換性を修正。

リリース 1.1 (2011 年 10 月 9 日)¶

互換性のない変更¶

The py:module directive doesn't output its platform option value anymore. (It was the only thing that the directive did output, and therefore quite inconsistent.)
古いパッケージへの依存を解除しました。現在は以下のパッケージ、バージョンが必要です:
- Pygments >= 1.2
- Docutils >= 0.7
- Jinja2 >= 2.3

機能拡張¶

Python 3.xサポートの追加。
新しいビルダーとサブシステム
- Texinfoビルダーの追加
- 内容の国際化(i18n)、 gettext ビルダーと、関連のユーティリティの追加
- Added the websupport library and builder.
- #98: sphinx-apidoc スクリプトの追加。これは、モジュールやパッケージのドキュメントを生成するための、autodocディレクティブを含むソースファイルの階層を自動生成します。
- #273: 英語以外の言語の全文テキスト検索サポートを追加するAPIの追加。日本語のサポートの追加。
マークアップ:
- #138: index ロールをインラインでの索引エントリーを作るために追加しました。
- #454: indexマークアップの能力拡張。 see/seealsoエントリーや、mainエントリーの登録が可能に。
- #460: HTML のセクションの深さを toctree での numbered オプションを利用して制限できるようにしました。
- #586: glossary のマークアップの機能拡張が行われ、定義ごとに複数の用語が定義できるようになった。
- #478: Added py:decorator directive to describe decorators.
- C++ドメインで、配列の定義のサポート。
- C++ ドメインがdocフィールドをサポート(ディレクティブ内での :param x:).
- only ディレクティブ内のセクションヘッダも、きちんと正しくハンドリングされるようになった。
- ソースコードディレクティブに emphasize-lines オプションを追加しました。
- #678: C++ ドメインがスーパークラスをサポートするようになりました。
HTMLビルダー:
- pyramid テーマの追加。
- #559: html_add_permalinks is now a string giving the text to display in permalinks.
- #259: HTMLテーブルで、偶数行と奇数行でゼブラ模様になるようなCSSの追加。
- #554: テーマオプション 'sidebarwidth' を基本テーマに追加しました。
他のビルダー:
- #516: Added new value of the latex_show_urls option to show the URLs in footnotes.
- #209: Added text_newlines and text_sectionchars config values.
- Added man_show_urls config value.
- #472: linkcheck builder: Check links in parallel, use HTTP HEAD requests and allow configuring the timeout. New config values: linkcheck_timeout and linkcheck_workers.
- #521: Added linkcheck_ignore config value.
- #28: LaTex ビルダーがテーブルの行/colspans をサポートしました。
設定と拡張:
- #537: Added nitpick_ignore.
- #306: env-get-outdated イベントの追加。
- Application.add_stylesheet() now accepts full URIs.
Autodoc:
- #564: Add autodoc_docstring_signature. When enabled (the default), autodoc retrieves the signature from the first line of the docstring, if it is found there.
- #176: private-members オプションをautodocディレクティブに追加。
- #520: special-members オプションをautodocディレクティブに追加。
- #431: 属性に対するドキュメントコメントを同じ行の配置で与えられるようになりました。
- #437: autodocで、クラスのデータ属性の値が表示されるようになった。
- autodocは functools.partial オブジェクトのシグニチャのドキュメントもサポートした。
他の拡張:
- sphinx.ext.mathjax 拡張の追加。
- #443: 外部のGraphvizファイルを参照できるようになった。
- graphvizディレクティブに inline オプションの追加。LaTeX出力のデフォルト(ブロック・スタイル)の修正。
- #590: graphvizディレクティブに caption オプションを追加。
- #553: Added testcleanup blocks in the doctest extension.
- #594: trim_doctest_flags now also removes <BLANKLINE> indicators.
- #367: 継承ダイアグラムで、非公開メンバーを自動で排除するようになったのと、この機能を有効か無効か切り替えるスイッチが追加された。
- pngmath_add_tooltips を追加。
- math 拡張の displaymath ディレクティブが式にラベルを与えるための label に加えて name をサポートするようになりました、これは Docutils との互換性のためです。
新言語:
- #221: スウェーデン語翻訳を追加しました。
- #526: イラン語翻訳を追加しました。
- #694: ラトビア語翻訳を追加しました。
- ネパール語翻訳を追加しました。
- #714: 韓国語翻訳を追加しました。
- #766: エストニア語翻訳を追加しました。
Release 0.6.8 (in development)
- #778: 検索ページからリンクされたページでの "hide search matches" リンクの修正
- "viewcode" 拡張により参照されたソースの位置を修正