Sphinx 1.3¶
リリース 1.3.6 (2016年2月29日)¶
機能拡張¶
#1873, #1876, #2278: Add
page_source_suffixhtml context variable. This should be introduced withsource_parsersfeature. Thanks for Eric Holscher.
バグ修正¶
#2265: Fix babel is used in spite of disabling it on
latex_elements#2295: Avoid mutating dictionary errors while enumerating members in autodoc with Python 3
#2291: Fix pdflatex "Counter too large" error from footnotes inside tables of contents
#2292: Fix some footnotes disappear from LaTeX output
#2287:
sphinx.transforms.Localealways uses rst parser. Sphinx i18n feature should support parsers that specified source_parsers.#2290: Fix
sphinx.ext.mathbaseuse of amsfonts may break user choice of math fonts#2324: Print a hint how to increase the recursion limit when it is hit.
#1565, #2229: Revert new warning; the new warning will be triggered from version 1.4 on.
#2329: Refresh environment forcedly if source directory has changed.
#2019: Fix the domain objects in search result are not escaped
リリース 1.3.5 (2016年1月24日)¶
バグ修正¶
LaTeXとtexinfoのビルダーでWARNINGログに、行番号としてNoneが表示されていた問題を修正
citation関連のWARNINGログに、ファイル名としてNoneが表示されていた問題を修正
LaTeXとtexinfoのビルダーでWARNINGログに、行番号としてNoneが表示されていた問題を修正
索引(インデックス)のWARNINGログに、行番号としてNoneが表示されていた問題を修正しました。
#2026: リンクを含む parsed-literal がLaTeXビルダーでうまく扱えなかった問題を修正しました。
#2243: classのdocstringとしておかしな型が指定されている場合にクラッシュしないように無視するよう修正しました。
#2247: #2205 の修正により定義リストのclassifierとして正規表現の特殊文字を持つ場合の動作を修正しました。
#1565: Sphinx will now emit a warning that highlighting was skipped if the syntax is incorrect for
code-block,literalincludeand so on.#2211: テーブル内にパラグラフがある場合、LaTeX出力が正しく動作しない問題を修正しました。
#2253:
literalincludeディレクティブの:pyobject:オプションが、ブロックが空行またはコメントから始まる場合にインデントを検知できない問題を修正しました。:maxdepth:が設定されていない場合に見出しが出力されない問題を修正ました (#771 参照)参照先がorphanのドキュメント内にある場合の
:numref:のワーニングを分かりやすいものに変更しました (#2244 参照)。
リリース 1.3.4 (2016年1月12日)¶
バグ修正¶
#2134: 参照を含むfigureキャプションがLaTeXでエラーとなる問題を修正しました。
#2094: 参照を含むrubricがLaTeXでうまく扱えなかった問題を修正しました。
#2147: Fix literalinclude code in latex does not break in pages
#1833: Fix email addresses is showed again if latex_show_urls is not
None#2176: sphinx.ext.graphviz: SVG出力では<img>タグの代わりに<object>タグを利用するよう変更しました。
#967: SVG形式の継承ダイアグラムがリンクが張られていない問題を修正しました。
#1237: 定義リスト内の脚注がLaTeXでうまく扱えなかった問題を修正しました。
#2168: rawディレクティブがtextライターで動作しなかった問題を修正しました。
#2171: Unicodeを含むURLリンクチェックできない問題を修正しました。
#2181: LaTeX: ドットを二つ以上含むファイル名を持つ画像ファイルに対応しました
#2189: ディレクトリの最初のファイルにおいて、前ページへのリンクが同ディレクトリの最後のファイルになってしまう問題を修正しました。
#2003: Python2で
make linkcheckを実行した際にデコードエラーになる問題を修正しました。#2186: LaTeX出力において、数式の中でmathbbを利用できるようにしました
#1480, #2188: LaTeX出力において、セクション名に数式を扱えるようになりました。
#2071: 脚注への参照を二回以上セクション名に含められない問題を修正しました。
#2040: Fix UnicodeDecodeError in sphinx-apidoc when author contains non-ASCII characters
#2193: ソースディレクトリと出力先ディレクトリに同じものを指定した場合にshutil.SameFileError例外が発生する問題を修正しました。
#2178: Fix unparsable C++ cross-reference when referencing a function with
:cpp:any:#2206: figureキャプションに脚注を含んでいた場合にLaTeXビルドが失敗していた問題を修正しました。
#2201: 30行を超えるテーブルの見出しが間違っている問題を修正しました。
#2213: classicテーマの<blockquote>のスタイルを調整しました。
#1815: warniserrorオプションが指定されていても、リンクチェックで不正なリンクを発見してもエラーとならない問題を修正しました。
#2197: index.rstが存在しない場合のエラー内容を分かりやすいものに変更しました。
#1894: quickstartコマンドで生成されるMakefileのphonyターゲットを更新しました。
#2125: 結合したフィールド(
GroupedFieldおよびTypedField)の動作を統一しました。#1408: latex_logoの指すファイルが存在しない場合に例外が発生する問題を修正しました。
#771: toctreeのmaxdepth指定がLaTeX出力に反映されない問題を修正しました。
#1820: On Windows, console coloring is broken with colorama version 0.3.3. Now Sphinx use colorama>=0.3.5 to avoid this problem.
#2072: 章の名前に脚注が含まれていた場合にPDF出力で正しく表示されない問題を修正しました。
#1580: longtableに段落が含まれていた場合にLaTeX出力で正しく扱われない問題を修正しました。
#1366: LaTeX出力の一部のケースにおいて画像がセンタリングされない問題を修正しました。
#1860: 変数を含む
:samp:ロールを利用した場合に、manページ出力でフォントが正しくリセットされない問題を修正しました。#1610: Sphinx crashes in Japanese indexing in some systems
mecabの初期化に失敗した場合、Sphinxがクラッシュする問題を修正しました。
#2160: セクション名に画像を利用した場合、PDF出力で正しくない見出しが生成されてしまう問題を修正しました。
#2172: Fix dysfunctional admonition
\py@lightboxin sphinx.sty. Thanks to jfbu.#2198,#2205:
make gettextで定義リストのをmsgidに出力する際に原文と異なる文字列を生成していました。#2062: Python2環境において、doctest内に含まれるエスケープ文字を誤って解釈、処理していたため、doctestが失敗していました。
#2225: ハイフンではじまらないオプションが正しく扱われない問題を修正しました。
#2226: :nowrap: オプション利用時に数式がHTMLエンコードされない問題を修正しました (jsmath, mathjax)。
#1601, #2220: 'any' role breaks extended domains behavior. Affected extensions doesn't support resolve_any_xref and resolve_xref returns problematic node instead of
None. sphinxcontrib-httpdomain is one of them.#2229: 不明なオプションを参照した際に警告を出力するようになりました。
リリース 1.3.3 (2015年12月2日)¶
バグ修正¶
#2177: 並列ビルドがハングアップする問題
#2012:
numfig_formatが不正な場合に例外が発生していた問題を修正しました。#2142: ミニファイされていないJSファイルを
sphinx/search/non-minified-js/*.jsとして同梱し、PyPIでのソース配布に含めました。#2148: 日本語などの非アスキー文字を含むドキュメントでdevhelpをビルドするとエラーが発生する問題を修正しました。
リリース 1.3.2 (2015年11月29日)¶
機能拡張¶
#1935: latex_elementsで "numfig_format" をオーバーライド可能にしました。
バグ修正¶
#1976: Babel バージョン "2.0" を利用しないようにしました。このバージョンはWindows環境で正しく動作しません。
Add a "default.css" stylesheet (which imports "classic.css") for compatibility
#1788: graphviz拡張が、captionのオプションが存在するときに例外を発生させていました。
#1789:
literalincludeの:pyobject:オプションを使うと、class定義以降の行も含めて表示していました。#1790:
literalincludeが先頭と末尾の空白行を取り除いてしまっていました。#1802: テーマプラグインが別のテーマを継承している場合に、プラグイン読込を自動的に行うようにしました。ありがとう Takayuki Hirai
#1794: custom theme extended from
alabasterorsphinx_rtd_themecan't find base theme.#1834: compatibility for Docutils 0.13: handle_io_errors keyword argument for docutils.io.FileInput cause TypeError.
#1823: sphinx-apidocの <module_path> に '.' を指定した場合、分かりにくいエラーが発生していました。修正によって、 '.' は自動的に絶対パスに読み替えられます。
metadataに対応していないSphinx拡張をセットアップする際にクラッシュしていました。
#1784: ミニファイしていないJSコードを
sphinx/search/non-minified-js/*.jsに含めました。#1822, #1892: Fix regression for #1061. autosummary can't generate doc for imported members since Sphinx 1.3b3. Thanks to Eric Larson.
#1793, #1819: text出力で "see also" の直後に1行目が表示され、改行されない問題を修正しました。ありがとう Takayuki Hirai.
#1780, #1866: "make text" で "class" キーワードが2回出力されていました。ありがとう Takayuki Hirai.
#1871: LaTeX 出力で、1列複数行にまたがるセルの出力を修正しました。
Python3.5環境で、HTMLParseError例外が発生していたのを修正しました。
#1949: coverageビルダーにおいて、descriptorで挙動を変更している場合に処理が中断するのを避けるため、
safe_getattrを使うようにしました。#1915: doc field type の値にスマートクォートを生成しないように修正しました。
#1796: Python3環境で、.moファイルの自動ビルドがUnicodeDecodeErrorを引き起こしていました。
#1923: latex babelの機能は、babelの要素が空でない場合だけ使うようにしました。
#1942: WebsupportでKeyErrorが発生していました。
#1903: 用語集の用語に奇妙なidが振られている問題を修正しました。
term : classifier1 : classifier2のように、定義リストが2つ以上のclassifierを持っている場合に、make textがクラッシュする問題を修正しました。#1855: make gettext で、classifier付きの定義リストの出力が壊れていました。
#1869: 非アスキー文字を含むファイルの読み込みでUnicodeDecodeErrorが発生していました。ありがとう Marvin Schmidt.
#1798: LaTeXのビルドで、タイトルにリンクを含む場合の出力を修正しました。
#1725: Python2環境で、非アスキー文字を使用したdoctestで
'ascii' codec can't decode byte例外が発生していました。#1540: toctreeの循環参照がRuntimeError例外を起こしていました。
#1983: i18n翻訳機能がセクション名への参照を壊していました。
#1990: LaTeX出力で、toctreeのキャプションに tableofcontentsを使うようにしました。
#1987: LaTeXビルダーで、
:menuselection:と:guilabel:内の&記号が無視されていた問題を修正しました。#1994: More supporting non-standard parser (like recommonmark parser) for Translation and WebSupport feature. Now node.rawsource is fall backed to node.astext() during Docutils transforming.
#1989: "make blahblah" on Windows indicate help messages for sphinx-build every time. It was caused by wrong make.bat that generated by Sphinx 1.3.0/1.3.1.
Python2環境で、sphinx-quickstartで生成したconf.pyの'version'と'release'の設定値の前に u を付けるようにしました。
#2102: WindowsのPython3環境で
|today|を使い、これが非アスキー文字列を含む日付フォーマットの場合にUnicodeEncodeErrorが発生していました。#1974: UnboundLocalError: local variable 'domain' referenced before assignment when using
anyrole andsphinx.ext.intersphinxin same time.#2121: ページの本文とページのタイトルそれぞれにのみある単語を同時に検索しようとするとページが見つからない問題を修正しました。
#1884, #1885: HTMLテーマプラグインが他のプラグインテーマから継承できない問題を修正しました。ありがとう Suzumizaki.
#1818:
sphinx.ext.tododirective generates broken html class attribute as 'admonition-' whenlanguageis specified with non-ASCII linguistic area like 'ru' or 'ja'. To fix this, nowtododirective can use:class:option.#2140: テーブル内に脚注がある場合、LaTeX出力が壊れていた問題を修正しました。
#2127: Python3環境で、HTML検索機能のためのMecabBinderが動作していませんでした。ありがとう Tomoko Uchida.
リリース 1.3.1 (2015年3月17日)¶
バグ修正¶
#1769: sphinx-quickstartで作成されるファイルやディレクトリが既存のファイルやディレクトリと衝突しない場合は、指定されたディレクトリが空でなくても実行します。ありがとう WAKAYAMA shirou.
#1773: sphinx-quickstartのオプションでプロジェクト名等に非アスキー文字列(日本語等)を指定できない問題。
#1766: "Python 2.6以降で実行" という説明がミスリードなので3.3以降とも明記。
#1772: docstringに
:param .write:のようなパラメータ定義を書くとビルドに失敗する問題。#1770, #1774:
literalincludeに空のファイルを指定すると例外が発生する問題。ありがとう Takayuki Hirai.#1777: Sphinx 1.3 でテーマプラグインをロードできない問題。ありがとう tell-k.
#1776: conf.pyの
source_suffix = ['.rst']が1.3以前のSphinxで不親切なエラーを発生させる問題。#1771: 自動 .mo ビルドが正しく行われない問題。
#1783: Autodoc: Python2 Allow unicode string in
__all__. Thanks to Jens Hedegaard Nielsen.#1781: Setting
html_domain_indicesto a list raises a type check warnings.
リリース 1.3 (2015年3月10日)¶
互換性のない変更¶
ref,term,menuselロールは今後 emphasis ノードを生成しません。もし、今後もイタリック体で表示したい場合は、スタイルシートを調整してください。numrefロールは%sを表示時に図表番号に置き換えるようにしました。以前は#を使用していました。
機能拡張¶
Add convenience directives and roles to the C++ domain: directive
cpp:varas alias forcpp:member, role:cpp:varas alias for:cpp:member, and roleanyfor cross-reference to any C++ declaraction. #1577, #1744conf.pyの設定
source_suffixに複数の拡張子をリストで指定できるようになりました。Add the ability to specify source parsers by source suffix with the
source_parsersconfig value.#1675: 新しいビルダー AppleHelpBuilder を追加しました。Apple Help Booksを出力できます。
バグ修正¶
1.3b3 の変更でmake gettextの出力が壊れていました。 "foo bar" と "version changes in 1.3: foo bar" のように多重にmsgidを出力していました。
#1745: footnote内で自身のfootnoteを参照している場合、latexビルダーが、関数の再帰数の上限に達してしまう問題 。
#1748: Python 2.6環境で、sphinx/ext/ifconfig.pyがSyntaxError
#1658, #1750: オプション書式で -, /, + で始まっていないときにリンクが作成されず警告が表示される問題を修正。ありがとうTakayuki Hirai
#1753: C++ドメインで複雑な定義のサポートを追加。
#1700:
toctreeに:caption:オプションを追加。#1742:
:name:option is provided fortoctree,code-blockandliteralincludedirectives.#1756: 検索結果で不正なセクション名が表示されている問題。1.3b3以降で発生。
#1746: C++ドメインで、名前の解決方法を修正し、定義内での名前解決で不足していた処理を追加。
#1765: C++ドメインで、完全修飾名のためのページハッシュidの互換性を修正。
ドキュメント¶
#1651: Add
vartypefield description for python domain.
リリース 1.3b3 (2015年2月24日)¶
互換性のない変更¶
Dependency requirement updates: Docutils 0.11, Pygments 2.0
The
gettext_enablesconfig value has been renamed togettext_additional_targets.#1735: Use https://docs.python.org/ instead of
httpprotocol. It was used forsphinx.ext.intersphinxand some documentation.
機能拡張¶
#1346: あたらしいデフォルトテーマを追加しました;
Add '
alabaster' theme.Add '
sphinx_rtd_theme' theme.The 'default' html theme has been renamed to 'classic'. 'default' is still available, however it will emit notice a recommendation that using new '
alabaster' theme.
highlight_options設定値を追加しました。conf.pyの
language設定値がHTMLテンプレートで使えるようになりました。env-updatedイベントで値を返せるようになりました。これは、イテラブルなオブジェクト(リスト等)で再書き出ししたいソースファイル名(docname)です。#772: Support for scoped and unscoped enums in C++. Enumerators in unscoped enums are injected into the parent scope in addition to the enum scope.
conf.pyに
todo_include_todos設定を出力するようになりました。HTMLのパンくずリストのタグにcssのclass "nav-item" と "nav-item-N" (nav-item-0, 1, 2...) を設定しました。
New option
sphinx-quickstart --use-make-modefor generating Makefile that use sphinx-build make-mode.#1235: i18n: several node can be translated if it is set to
gettext_additional_targetsin conf.py. Supported nodes are:'literal-block'
'doctest-block'
'raw'
'image'
#1227: Add
html_scaled_image_linkconfig option to conf.py, to control scaled image link.
バグ修正¶
LaTeXライターが行をまたがる結合セルを正しく出力するようになりました。
#1674: モジュールの
__all__が文字列のリストでない場合にクラッシュする問題を修正しました。#1629: Use VerbatimBorderColor to add frame to code-block in LaTeX
On windows, make-mode didn't work on Win32 platform if Sphinx was invoked as
python sphinx-build.py.#1687: linkcheckビルダーは401 Unauthorizedを"working"として扱うようになりました。
#1690: toctrees with
globoption now can also contain entries for single documents with explicit title.#1591: html search results for C++ elements now has correct interpage links.
bizstyle テーマ: ネストした長いタイトルページが長いパンくずリストを生成しページレイアウトを破壊する。
bizstyle テーマ: すべてのパンくずリストアイテムがモバイルブラウザ(iPhone5s safari)で'Top'になる問題を修正しました。
#1722: restore
toctree()template function behavior that was changed at 1.3b1.#1732: i18n: localized table caption raises exception.
#1718:
:numref:does not work with capital letters in the label#1630: resolve CSS conflicts,
div.containercss target for literal block wrapper now renamed todiv.literal-block-wrapper.sphinx.util.pycompathas been restored in its backwards-compatibility; slated for removal in Sphinx 1.4.#1719: LaTeX writer does not respect
numref_formatoption in captions
リリース 1.3b2 (2014年12月5日)¶
互換性のない変更¶
Python 2.6以上が必要なsetuptools-7.0にバンドルされたez_setup.pyをアップデート。
機能拡張¶
#1597: Added possibility to return a new template name from
html-page-context.PR#314, #1150: Configuration values are now checked for their type. A warning is raised if the configured and the default value do not have the same type and do not share a common non-trivial base class.
バグ修正¶
PR#311: sphinx-quickstart がPython3.4で動作しない問題。
#564:
autodoc_docstring_signature設定値の追加。docstringの最初の行をシグニチャとして扱う。ソース・ファイルが追加された際にリビルドが予期せずクラッシュを発生させる問題を修正しました。
#1607: "howto" クラスを利用したドキュメントをlatexpdfでビルドした際にクラッシュする問題を修正しました。
#1251: Fix again. Sections which depth are lower than :tocdepth: should not be shown on localtoc sidebar.
make-mode didn't work on Win32 platform if Sphinx was installed by wheel package.
リリース 1.3b1 (2014年10月10日)¶
互換性のない変更¶
Python 2.5, 3.1, 3.2 のサポートを終了
Dropped support for Docutils versions up to 0.9.
sphinx.ext.oldcmarkupエクステンションを削除廃止された
exclude_trees,exclude_dirnamesおよびunused_docsconf.pyの設定を削除新規ノード
sphinx.addnodes.literal_strongの追加。このテキストはリテラル (例えばスマートクォート無し)で強調フォント中に表示されます。Writer実装ではこのノードを扱えるように実装が必要です。PR#269, #1476: replace
<tt>tag by<code>. User customized stylesheets should be updated If the css contain some styles fortt>tag. Thanks to Takeshi Komiya.#1543:
templates_pathis automatically added toexclude_patternsto avoid reading autosummary rst templates in the templates directory.Custom domains should implement the new
Domain.resolve_any_xrefmethod to make theanyrole work properly.gettext builder: gettext doesn't emit uuid information to generated pot files by default. Please set
Truetogettext_uuidto emit uuid information. Additionally, if thepython-levenshtein3rd-party package is installed, it will improve the calculation time.gettext builder: disable extracting/apply 'index' node by default. Please set 'index' to
gettext_enablesto enable extracting index entries.PR#307: LaTeX出力で、コードブロック部分にframeを追加。 ありがとう Takeshi Komiya
機能拡張¶
Python 3.4 サポートを追加。
Add support for Docutils 0.12
NumPy および Google スタイルの docstring をドキュメントに取り込む
sphinx.ext.napoleon拡張を追加。Added support for parallel reading (parsing) of source files with the
sphinx-build -joption. Third-party extensions will need to be checked for compatibility and may need to be adapted if they store information in the build environment object. Seeenv-merge-info.Added the
anyrole that can be used to find a cross-reference of any type in any domain. Custom domains should implement the newDomain.resolve_any_xrefmethod to make this work properly.例外ログに、Sphinxが出力した最新10件のメッセージを含むようになりました。
Added support for extension versions (a string returned by
setup(), these can be shown in the traceback log files). Version requirements for extensions can be specified in projects using the newneeds_extensionsconfig value.Changing the default role within a document with the default-role directive is now supported.
PR#214: Added stemming support for 14 languages, so that the built-in document search can now handle these. Thanks to Shibukawa Yoshiki.
PR#296, PR#303, #76: numfig feature: Assign numbers to figures, tables and code-blocks. This feature is configured with
numfig,numfig_secnum_depthandnumfig_format. Alsonumrefrole is available. Thanks to Takeshi Komiya.PR#202: Allow "." and "~" prefixed references in
:param:doc fields for Python.PR#184: Add
autodoc_mock_imports, allowing to mock imports of external modules that need not be present when autodocumenting.#925: Allow list-typed config values to be provided on the command line, like
-D key=val1,val2.#668: Allow line numbering of
code-blockandliteralincludedirectives to start at an arbitrary line number, with a newlineno-startoption.PR#172, PR#266: The
code-blockandliteralincludedirectives now can have acaptionoption that shows a filename before the code in the output. Thanks to Nasimul Haque, Takeshi Komiya.sphinx-quickstartはドキュメントの言語指定を受け付けます。
PR#217: Added config values to suppress UUID and location information in generated gettext catalogs.
PR#236, #1456: apidoc: Add a -M option to put module documentation before submodule documentation. Thanks to Wes Turner and Luc Saffre.
#1434: Provide non-minified JS files for jquery.js and underscore.js to clarify the source of the minified files.
PR#252, #1291: Windows color console support. Thanks to meu31.
PR#255: When generating latex references, also insert latex target/anchor for the ids defined on the node. Thanks to Olivier Heurtier.
PR#229: Allow registration of other translators. Thanks to Russell Sim.
Add app.set_translator() API to register or override a Docutils translator class like
html_translator_class.PR#267, #1134: add 'diff' parameter to literalinclude. Thanks to Richard Wall and WAKAYAMA shirou.
PR#272: 'bizstyle' テーマの追加。ありがとう Shoji KUMAGAI。
Automatically compile
*.mofiles from*.pofiles whengettext_auto_buildisTrue(default) and*.pois newer than*.mofile.#623:
sphinx.ext.viewcodesupports imported function/class aliases.PR#275:
sphinx.ext.intersphinxsupports multiple target for the inventory. Thanks to Brigitta Sipocz.PR#261: Added the
env-before-read-docsevent that can be connected to modify the order of documents before they are read by the environment.#1284: Program options documented with
optioncan now start with+.PR#291: The caption of
code-blockis recognized as a title of ref target. Thanks to Takeshi Komiya.PR#298: Add new API:
add_latex_package(). Thanks to Takeshi Komiya.#1344: add
gettext_enablesto enable extracting 'index' to gettext catalog output / applying translation catalog to generated documentation.PR#301, #1583: Allow the line numbering of the directive
literalincludeto match that of the included file, using a newlineno-matchoption. Thanks to Jeppe Pihl.PR#299: add various options to sphinx-quickstart. Quiet mode option
--quietwill skips wizard mode. Thanks to WAKAYAMA shirou.#1623: Return types specified with
:rtype:are now turned into links if possible.
バグ修正¶
PR#1438: jQuery をバージョン1.8.3 からバージョン 1.11.1 に更新。
#1568: "centered"ディレクティブがリファレンスを含んでいるとクラッシュする問題を修正。
sphinx.ext.autodocがpython-2.5で再び動作するようになりました。
#1563:
add_search_language()raises AssertionError for correct type of argument. Thanks to rikoman.#1174: Fix smart quotes being applied inside roles like
programormakevar.PR#235: comment db schema of websupport lacked a length of the node_id field. Thanks to solos.
#1466,PR#241: Fix failure of the cpp domain parser to parse C+11 "variadic templates" declarations. Thanks to Victor Zverovich.
#1459,PR#244: デフォルトのmathjax js のパスが
http://を指しており、これがhttpsからのhttp参照のエラーの原因となっていた。ありがとうsbrandtb と robo9k。PR#157: autodoc remove spurious signatures from @property decorated attributes. Thanks to David Ham.
PR#159: Add coverage targets to quickstart generated Makefile and make.bat. Thanks to Matthias Troffaes.
#1251: When specifying toctree :numbered: option and :tocdepth: metadata, sub section number that is larger depth than
:tocdepth:is shrunk.PR#260: Encode underscore in citation labels for latex export. Thanks to Lennart Fricke.
PR#264: Fix could not resolve xref for figure node with :name: option. Thanks to Takeshi Komiya.
PR#265: Fix could not capture caption of graphviz node by xref. Thanks to Takeshi Komiya.
PR#263, #1013, #1103: Rewrite of C++ domain. Thanks to Jakob Lykke Andersen.
Hyperlinks to all found nested names and template arguments (#1103).
Support for function types everywhere, e.g., in std::function<bool(int, int)> (#1013).
Support for virtual functions.
Changed interpretation of function arguments to following standard prototype declarations, i.e., void f(arg) means that arg is the type of the argument, instead of it being the name.
テストをアップデート。
Updated documentation with elaborate description of what declarations are supported and how the namespace declarations influence declaration and cross-reference lookup.
Index names may be different now. Elements are indexed by their fully qualified name. It should be rather easy to change this behaviour and potentially index by namespaces/classes as well.
PR#258, #939: Add dedent option for
code-blockandliteralinclude. Thanks to Zafar Siddiqui.PR#268: Fix numbering section does not work at singlehtml mode. It still ad-hoc fix because there is a issue that section IDs are conflicted. Thanks to Takeshi Komiya.
PR#273, #1536: Fix RuntimeError with numbered circular toctree. Thanks to Takeshi Komiya.
PR#274: Set its URL as a default title value if URL appears in toctree. Thanks to Takeshi Komiya.
PR#276, #1381:
rfcandpeproles support custom link text. Thanks to Takeshi Komiya.PR#277, #1513: highlights for function pointers in argument list of
c:function. Thanks to Takeshi Komiya.PR#278: Fix section entries were shown twice if toctree has been put under only directive. Thanks to Takeshi Komiya.
#1547: pgen2 tokenizer doesn't recognize
...literal (Ellipsis for py3).PR#294: On LaTeX builder, wrap float environment on writing literal_block to avoid separation of caption and body. Thanks to Takeshi Komiya.
PR#295, #1520:
make.bat latexpdfmechanism tocdback to the current directory. Thanks to Peter Suter.PR#297, #1571: Add imgpath property to all builders. It make easier to develop builder extensions. Thanks to Takeshi Komiya.
#1584: HTML "top" リンクが正しくマスターdocを指すよう修正。
#1585: Autosummary of modules broken in Sphinx 1.2.3.
#1610: Sphinx cause AttributeError when MeCab search option is enabled and python-mecab is not installed.
#1674: モジュールの
__all__が文字列のリストでない場合にクラッシュする問題を修正しました。#1673: Fix crashes with
nitpick_ignoreand:doc:references.#1686: ifconfig directive doesn't care about default config values.
#1642: Fix only one search result appearing in Chrome.
ドキュメント¶
Add clarification about the syntax of tags. (
doc/markup/misc.rst)