Sphinx 1.0¶

リリース 1.0.8 (Sep 23, 2011年)¶

#627: オートサマリー生成でのアトリビュートエラーに対してのtracebackを修正。
Fix the abbr role when the abbreviation has newlines in it.
#727: Fix the links to search results with custom object types.
#648: Fix line numbers reported in warnings about undefined references.
#696, #666: Fix C++ array definitions and template arguments that are not type names.
#633: Allow footnotes in section headers in LaTeX output.
#616: Allow keywords to be linked via intersphinx.
#613: Allow Unicode characters in production list token names.
#720: Add dummy visitors for graphviz nodes for text and man.
#704: 画像ファイルが重複するバグを修正しました。
#677: Fix parsing of multiple signatures in C++ domain.
#637: Ignore Emacs lock files when looking for source files.
#544: Allow .pyw extension for importable modules in autodoc.
#700: Use $(MAKE) in quickstart-generated Makefiles.
#734: Make sidebar search box width consistent in browsers.
#644: Fix spacing of centered figures in HTML output.
#767: Safely encode SphinxError messages when printing them to sys.stderr.
#611: Fix LaTeX output error with a document with no sections but a link target.
Correctly treat built-in method descriptors as methods in autodoc.
#706: Stop monkeypatching the Python textwrap module.
#657: viewcode now works correctly with source files that have non-ASCII encoding.
#669: Respect the noindex flag option in py:module directives.
#675: Fix IndexErrors when including nonexisting lines with literalinclude.
#676: Respect custom function/method parameter separator strings.
#682: jQuery >= 1.5 でのJS非互換性を修正しました。
#693: Fix double encoding done when writing HTMLHelp .hhk files.
#647: Do not apply SmartyPants in parsed-literal blocks.
C++ドメインで、配列の定義のサポート。

リリース 1.0.7 (2011 年 1 月 15 日)¶

#347: Fix wrong generation of directives of static methods in autosummary.
#599: Import PIL as from PIL import Image.
#558: Fix longtables with captions in LaTeX output.
LaTeXの出力で、トークン参照を再度ハイパーリンクとして動作させます。
#572: デフォルトで、参照したラベルが見つからない時に警告を表示。
#536: nitpickyモード(訳注: verboseと同じ意味？恐らく警告をたくさん出す)時に、見つからない参照ターゲットについての警告を出すときに、行番号も出力。
#590: LaTeX出力時の、graphvizダイアグラムのインライン表示の修正。
#589: setupコマンド内で、app.build()を使用してビルド。
継承ダイアグラムを生成する時に、親クラスに組み込みクラスが含まれていた時に例外が投げられるバグの修正。
C++ドメインのオブジェクトの、汎用的なインデックスのリンクの修正。
#332: LaTeX出力で、admonitionの境界線の表示。
#573: ファイルを削除した後にリビルドすると、KeyErrorが発生する事象の修正。
globスタイルのtoctree内で、ファイルを削除したときに出力されるtracebackの修正。
もし、autodocのオブジェクトがインポートできなかった時に、次のビルドで、そのディレクティブを含むドキュメントを常に再読込するようにした。
もし、autodocのオブジェクトがインポートできなかった時に、importエラーの完全なtracebackを表示するようにした。
ダウンロードファイルや画像ファイルが削除された場合に、それが通知されないバグの修正。
#571: Cドメインで、 ~ が先頭に付く時のクロスリファレンスを実装した。
# #556の修正(LaTeX出力)のリグレッションの修正。
#568: デスクリプタがついたクラスの属性ドキュメントの検索の修正が行われ、コメントのドキュメントが正しく動作するようになった。
ターゲットより前にある only ディレクティブのtracebackの修正。
C++ドメインのオブジェクトが重複した場合に発生するtracebackの修正。
Fix JavaScript domain links to objects with $ in their name.

リリース 1.0.6 (2011 年 1 月 04 日)¶

#581: Pythonドメインでクロスリファレンスの対象が空の場合の問題を解決
#283: Chromeブラウザにおけるリテラルブロックでの表示問題を解決
#383, #148: Support sorting a limited range of accented characters in the general index and the glossary.
#570: Try decoding -D and -A command-line arguments with the locale's preferred encoding.
#528: Observe locale_dirs when looking for the JS translations file.
#574: Add special code for better support of Japanese documents in the LaTeX builder.
Regression of #77: If there is only one parameter given with :param: markup, the bullet list is now suppressed again.
#556: Fix missing paragraph breaks in LaTeX output in certain situations.
#567: Emit the autodoc-process-docstring event even for objects without a docstring so that it can add content.
#565: In the LaTeX builder, not only literal blocks require different table handling, but also quite a few other list-like block elements.
#515: Fix tracebacks in the viewcode extension for Python objects that do not have a valid signature.
Fix strange reports of line numbers for warnings generated from autodoc-included docstrings, due to different behavior depending on Docutils version.
C++ ドメインにいくつの修正を行いました。

リリース 1.0.5 (2010 年 11 月 12 日)¶

#557: Add CSS styles required by Docutils 0.7 for aligned images and figures.
In the Makefile generated by LaTeX output, do not delete pdf files on clean; they might be required images.
#535: ラインブロックを生成するLaTeX出力を修正
#544: .pyw をソースファイルの拡張子として使えるようにしました。

リリース 1.0.4 (2010 年 9 月 17 日)¶

#524: Open intersphinx inventories in binary mode on Windows, since version 2 contains zlib-compressed data.
#513: Allow giving non-local URIs for JavaScript files, e.g. in the JSMath extension.
#512: Fix traceback when intersphinx_mapping is empty.

リリース 1.0.3 (2010 年 8 月 23 日)¶

#495: Fix internal vs. external link distinction for links coming from a Docutils table-of-contents.
#494: Fix the maxdepth option for the toctree() template callable when used with collapse=True.
#507: Fix crash parsing Python argument lists containing brackets in string literals.
#501: Fix regression when building LaTeX docs with figures that don't have captions.
#510: Fix inheritance diagrams for classes that are not picklable.
#497: Introduce separate background color for the sidebar collapse button, making it easier to see.
#502, #503, #496: Fix small layout bugs in several builtin themes.

リリース 1.0.2 (2010 年 8 月 14 日)¶

#490: Fix cross-references to objects of types added by the add_object_type() API function.
Fix handling of doc field types for different directive types.
Allow breaking long signatures, continuing with backlash-escaped newlines.
Fix unwanted styling of C domain references (because of a namespace clash with Pygments styles).
Allow references to PEPs and RFCs with explicit anchors.
#471: LaTeXでの図への参照を修正
#482: When doing a non-exact search, match only the given type of object.
#481: Apply non-exact search for Python reference targets with .name for modules too.
#484: Fix crash when duplicating a parameter in an info field list.
#487: Fix setting the default role to one provided by the oldcmarkup extension.
#488: Fix crash when json-py is installed, which provides a json module but is incompatible to simplejson.
#480: Fix handling of target naming in intersphinx.
#486: Fix removal of ! for all cross-reference roles.

リリース 1.0.1 (2010 年 7 月 27 日)¶

#470: Fix generated target names for reST domain objects; they are not in the same namespace.
#266: ベンガル語を追加
#473: JavaScriptのオブジェクト名の解釈のバグを修正
#474: toctreeが無いときにSingleHTMLBuilderでのビルド出力を修正
intersphinxによりターゲットを明示してリンクされたオブジェクトの表示名を修正
JSONビルダーでのビルドを修正しました。
LaTeXでのオブジェクト説明での参照を修正しました。

リリース 1.0 (2010 年 7 月 23 日)¶

互換性のない変更¶

言語ドメインサポートを追加しました。ドメインとはディレクティブとロールの集合で例えばプログラミング言語の要素などです。いくつかのドメインを標準で提供しています:
- Python
- C
- C++
- JavaScript
- reStructuredText
The old markup for defining and linking to C directives is now deprecated. It will not work anymore in future versions without activating the oldcmarkup extension; in Sphinx 1.0, it is activated by default.
古いパッケージへの依存を解除しました。現在は以下のパッケージ、バージョンが必要です:
- Docutils >= 0.5
- Jinja2 >= 2.2
以下の非推奨エレメントが削除されました:
- 設定ファイルの exclude_dirs
- sphinx.builder モジュール

機能拡張¶

共通機能:
- Added a "nitpicky" mode that emits warnings for all missing references. It is activated by the sphinx-build -n command-line switch or the nitpicky config value.
- Makefileのターゲットに latexpdf を追加しました。
マークアップ:
- The menuselection and guilabel roles now support ampersand accelerators.
- docフィールドの新しい簡潔な文法として、次の書き方を推奨します: :param type name: description.
- Added tab-width option to literalinclude directive.
- titlesonly オプションを toctree ディレクティブに追加しました。
- Added the prepend and append options to the literalinclude directive.
- #284: 全てのdocinfoメタデータを著者だけではなくドキュメントのメタデータに入れるようにしました。
- The ref role can now also reference tables by caption.
- include ディレクティブは絶対パスをサポートします。これまではソースディレクトリからの相対パスとして解釈されていました。
- Python ドメインにおいて :func:`.name` のような参照は、もし完全一致するものが見つからない場合は、前に文字列があるものにマッチするようになりました。
設定:
- Added rst_prolog config value.
- Added html_secnumber_suffix config value to control section numbering format.
- Added html_compact_lists config value to control Docutils' compact lists feature.
- The html_sidebars config value can now contain patterns as keys, and the values can be lists that explicitly select which sidebar templates should be rendered. That means that the builtin sidebar contents can be included only selectively.
- html_static_path can now contain single file entries.
- The new universal config value exclude_patterns makes the old unused_docs, exclude_trees and exclude_dirnames obsolete.
- Added html_output_encoding config value.
- Added the latex_docclass config value and made the "twoside" documentclass option overridable by "oneside".
- Added the trim_doctest_flags config value, which is true by default.
- Added html_show_copyright config value.
- Added latex_show_pagerefs` and latex_show_urls config values.
- The behavior of html_file_suffix` changed slightly: the empty string now means "no suffix" instead of "default suffix", use None for "default suffix".
新しいビルダー:
- Epubビルダーを追加しました。
- manual pageビルダーを追加しました。
- 一つのHTMLファイルにまとめて出力するビルダーを追加しました。
HTML出力:
- インラインのroleはそのロール名のCSSクラス名が付くようになりました。このCSSクラス名を利用してデザインのカスタマイズを行えます。ドメインのロールは二つのCSSクラス domain と domain-rolename が設定されます。
- 同一ページ内への参照だけでなく、同一プロジェクト内への参照にはCSSクラス名 internal が付くようになりました。
- 外部への参照のデザインを調整可能とするため、 externalrefs テーマオプションがデフォルトのテーマに追加されました。
- デフォルトテーマにおいて、サイドバーに実験的な機能、サイドバー折りたたみ機能が追加されました。利用するためには collapsiblesidebar テーマオプションを指定して下さい。
- #129: HTML出力時に、目次ツリー全体を div タグで囲み、class名 toctree-wrapper を付けました。
- テンプレート内の toctree 呼び出しに maxdepth キーワード引数を追加し、ツリーの深さをコントロール出来るようにしました。
- テンプレート内の toctree 呼び出しに titles_only キーワード引数を追加しました。
- htmltitle ブロックをレイアウトテンプレートに追加しました。
- JavaScript検索において、 sys.argv のようにモジュール名とオブジェクト名を含む名前を検索出来るようにしました。
- 新しいテーマ haiku を追加しました。これは Haiku OS ユーザーガイドにインスパイアされています。
- 新しいテーマ nature を追加しました。
- 新しいテーマ agogo を追加しました。Andi Albrecht が作成しました。
- 新しいテーマ scrolls を追加しました。 Armin Ronacher が作成しました。
- #193: visitedlinkcolor テーマオプションをデフォルトテーマに追加しました。
- #322: 検索ページの応答速度を改善しました。検索インデックスを非同期で読み込むようにしています。
Sphinx拡張API:
- html-collect-pages を追加しました。
- Added needs_sphinx config value and require_sphinx() application API method.
- #200: Added add_stylesheet() application API method.
Sphinx拡張:
- viewcode 拡張を追加しました。
- extlinks 拡張を追加しました。
- autodocのソート順にsource順を指定する設定を追加しました。次のように記載します autodoc_member_order = 'bysource'
- Added autodoc_default_flags config value, which can be used to select default flags for all autodoc directives.
- intersphinxにおいて、他のプロジェクト内の名前付きラベルを参照する方法と、強制的にリンク先プロジェクト名を指定する方法を追加しました。
- #280: autodoc はドキュメントのインスタンス属性を __init__ メソッドで設定出来るようになりました。
- autosummary 拡張について、多くの改良と修正を行いました。ありがとう Pauli Virtanen.
- #309: The graphviz extension can now output SVG instead of PNG images, controlled by the graphviz_output_format config value.
- graphviz 拡張のディレクティブに alt オプションを追加しました。
- autodoc.between() に exclude 引数を追加しました。
翻訳:
- クロアチア語の翻訳を追加しました。ありがとう Bojan Mihelaト・
- トルコ語の翻訳を追加しました。ありがとう Firat Ozgul.
- カタロニア語の翻訳を追加しました。ありがとう Pau Fernテ。ndez.
- 中国語の翻訳をシンプルにしました。
- デンマーク語の翻訳を追加しました。ありがとう Hjorth Larsen.
- リトアニア語の翻訳を追加しました。ありがとう Dalius Dobravolskas.
Release 0.6.8 (in development)
- #445: dirhtml ビルダーで生成したHTMLで検索機能が有効でないURLを検索結果として表示していた問題を修正。
- #444: テンプレートで、"striptags" jinjaフィルタを使って正しく値をエスケープするようにした。