記録を変更する¶
バージョン3.5.0(開発中)¶
依存性.¶
互換性のない変更¶
捨てて使う.¶
sphinx.ext.autodoc.AttributeDocumenter.isinstanceattribute()
sphinx.ext.autodoc.directive.DocumenterBridge.reporter
sphinx.ext.autodoc.importer.get_module_members()
追加された機能¶
#8022:autodoc:docstringに含まれている場合、AutoDataおよびAutoAttributeコマンドは、変数の右手の値を表示しません。
:meta hide-value:
INFO-FIELD-LISTでは#8514:autodoc:再ロード関数のデフォルト値が省略番号である場合、実際の実装から取得します。
#8619:HTML:kbdロール複合キーのカスタマイズ可能なHTMLタグを生成する
#8634:HTML:JS/CSSの順序を以下のように変更することができます。
priority
のパラメータです。Sphinx.add_js_file()
そしてSphinx.add_css_file()
#6241:HTML:拡張呼び出し時に特定のページにJS/CSSファイルを追加することを許可する
app.add_js_file()
あるいは…。app.add_css_file()
開けるhtml-page-context
事件#8649:imgConverter:builderがミラータイプをサポートしている場合、可用性チェックをスキップします。
#8573:ナポレオン:以下のコマンドを使用してカスタム節のスタイルを変更することを許可します。
napoleon_custom_styles
#6241:mathjax:式を使用して文書にのみmathjax.jsを含む
#8651:標準ドメイン:行内の項目を持つタイトルへの交差参照が中断されました
#8681:ビューコード:インクリメンタル構築をサポート
#8132:追加
project_copyright
の別名としてcopyright
#207:現在
highlight_language
多言語をサポートする#2030:
code-block
そしてliteralinclude
パラメータなしでの自動削除をサポート:dedent:
選択権.C++も,式とエイリアス宣言におけるハイパーリンク演算子の再ロードである.
誤りを修正する¶
#741:autodoc:継承-クラス上のインスタンス·プロパティにはメンバーが適用されません。
#8592:autodoc:
:meta public:
変数に影響を与えない#8594:autodoc:空 __all__ 属性が無視される
#8315:autodoc:構造を解析できません。構造型書き込み
#8652:autodoc:モジュールに無効なタイプの注釈が含まれている場合、モジュール内のすべての変数注釈は無視されます。
#8693:autodoc:再ロード関数のデフォルト値は文字列として表示されます。
#8306:自動集計:使用:RECURSIVE:オプションの場合、シミュレーションモジュールは空ページとして記録されます。
#8618:HTML:複合鍵スペーサ(-,+または^)を打鍵として用いた場合、KBDキャラクタは、誤ったHTMLを生成する。
#8629:html:html_use_opensearchのタイプ警告表示2回
#8665:HTMLトピック:heme.confのglobaltoc_maxDeepを書き換えることができません。
#8094:texinfo:文書を含む異なるディレクトリ上の画像ファイルをコピーしません。
#8671:
highlight_options
機能しません#8341:C、宣言の名前のintersphinxルックアップ·タイプを修復します。
C、C+:通常、Intersphinxおよびロール·ルックアップ·タイプが修復されます。
#8683:
html_last_updated_fmt
UTCオフセット(%z)はサポートされていません#8683:
html_last_updated_fmt
%Zのために誤ったタイムゾーンを生成する#1112:
download
相対パスを指定すると、ロールが重複コピーを作成します
テストをする¶
バージョン3.4.3(2021年1月8日リリース)¶
誤りを修正する¶
#8655:autodoc:ターゲットモジュールに例外を引き起こすオブジェクトが含まれている場合、文書を生成することができません。
hasattr()
バージョン3.4.2(2021年1月4日リリース)¶
誤りを修正する¶
#8164:autodoc:シミュレーションクラスを継承するクラスは記録されていません。
#8602:autodoc:The
autodoc-process-docstring
イベントは意外にも非datadescriptorに送信された#8616:クラス外オブジェクトをautoclassコマンドに渡すとautodocが開始されます:AttributeError
バージョン3.4.1(2020年12月25日リリース)¶
誤りを修正する¶
#8559:順方向参照タイプの書き込みを使用する場合、autodocを誘発する:AttributeError
#8568:スロット属性をチェックする際にautocを誘発する:TypeError
#8567:autodoc:親クラスにインスタンス属性が誤って追加されました。
#8566:AutoDoc:The
autodoc-process-docstring
事件は意外にも別名類に出された#8583:autodoc:以下のように不要なオブジェクト比較を行う
__eq__
方法#8565:Linkcheck:リペアリンクタプルが比較できない場合、PriorityQueueが崩壊します。
バージョン3.4.0(2020年12月20日リリース)¶
互換性のない変更¶
#8105:autodoc:修飾クラスは、装飾子の署名ではなく、クラス構造関数の署名を表示する。
捨てて使う.¶
♪the
follow_wrapped
論争する.sphinx.util.inspect.signature()
♪the
no_docstring
論争する.sphinx.ext.autodoc.Documenter.add_content()
sphinx.ext.autodoc.Documenter.get_object_members()
sphinx.ext.autodoc.DataDeclarationDocumenter
sphinx.ext.autodoc.GenericAliasDocumenter
sphinx.ext.autodoc.InstanceAttributeDocumenter
sphinx.ext.autodoc.SlotsAttributeDocumenter
sphinx.ext.autodoc.TypeVarDocumenter
sphinx.ext.autodoc.importer._getannotations()
sphinx.ext.autodoc.importer._getmro()
sphinx.pycode.ModuleAnalyzer.parse()
sphinx.util.osutil.movefile()
sphinx.util.requests.is_ssl_error()
追加された機能¶
#8119:autodoc:メンバが含まれていないかどうかの判断が許可されます。
__all__
モジュールの属性は文書に記録されなければならない,または通過しない.autodoc-skip-member
事件#8219:autodoc:スーパークラスが汎用クラスであり、表示継承オプションが与えられている場合、汎クラスのパラメータは表示されません(Python 3.7以降)
自動ドッキング:追加
Documenter.config
アクセス配置対象としてのショートカットAutodoc:オプションの追加 [t] デフォルト値をNoneに設定すると,関数とメソッドの書き込みとなる.
#8209:autodoc:追加
:no-value:
選択権.autoattribute
そしてautodata
命令は変数のデフォルト値をキャンセルする#8460:autodoc:tying.NewTypeによって定義されるカスタムタイプをサポート
#8285:ナポレオン:追加
napoleon_attr_annotations
Docstringで任意のタイプが指定されていれば,ソースコード上のタイプ提示を自動的にマージする.#8236:ナポレオン:numpydocをサポートする“受信”部分
#6914:新しいイベントの追加
warn-missing-reference
クロスリファレンスを解析できない場合にはカスタム警告メッセージを定義する.#6914:解析に失敗した場合の詳細な警告
:ref:
参照物.#6629:リンクチェック:ビルダがレート制限を処理しています。見
linkcheck_retry_on_rate_limit
もっと細かいことを知っています。
誤りを修正する¶
#7613:autodoc:autoc尊重されない __signature__ クラス全員の
#4606:autodoc:引継ぎ方法の警告位置が正しくない
#8105:autodoc:クラスが修飾されている場合,クラス構造関数の署名が正しくない.
#8434:自動ドッキング:
autodoc_type_aliases
変数や属性に影響を与えない#8443:autodoc:Autodataコマンドは、PEP-526に基づくタイプの注釈変数のドキュメントを作成することができません。
#8443:autodoc:autotributeコマンドは、PEP-526に基づく未初期化変数のドキュメントを作成することができません。
#8480:autodoc:autoAttributeドキュメントを作成できません。 __slots__ 属性
#8503:Autoodoc:AutoAttribute GenericAliasクラス属性を正しく作成できないドキュメント
#8534:autodoc:autotributeエイリアスクラスの注釈属性のためのドキュメントを作成することができません。
#8452:autoc:autoc_type_aliases autoc_type hintsが“description”に設定されている場合は機能しません。
#8541:autoc:autoc_type_aliasesインスタンス属性には適用されないタイプの書き込み
#8460:autodoc:autodataおよびautotributeコマンドは、TypeVarsのタイプ情報を表示しません。
#8493:autodoc:カテゴリ名で動作しない内蔵への参照
#8522:autodoc:
__bool__
メソッドは呼び出すことができます#8067:autodoc:スーパークラスTYPE_COMMENTのインスタンス変数を表示しないタイププロンプト
#8545:AutoDoc:A __slots__ 文書文字列があっても属性は記録されていない
#741:autodoc:継承-クラス上のインスタンス·プロパティにはメンバーが適用されません。
#8477:自動集約:テンプレートにマルチバイト文字が含まれている場合、非utf-8 RESTファイルを生成します。
#8501:autosumary:要約抽出“el at”の後にテキストを分割します。意外なことに
#8524:HTML:“index”という文書上に誤ったurl_rootが生成された.
#8419:HTML検索:ロードしない
language_data.js
非検索ページでは#8549:I 18 N:
-D gettext_compact=0
もう役に立たなくなった#8454:raphviz:graphおよびdigraph命令のレイアウトオプションが機能しません。
#8131:Linkcheck:Head要求が重すぎる指向性をもたらす場合、GETを使用して、Head上の無限リダイレクトループを収容する。
#8437:Makefile:
make clean
空いているBUILDDIRは危険です#8365:PYドメイン名:
:type:
そして:rtype:
誤った曖昧なクラス検索警告を与える#8352:標準ドメイン:括弧で始まるオプションを解析できません。
#8519:LaTeX:See中間のページブレーキを防止する
#8520:C、AliasNodeのコピーを修復します。
バージョン3.3.1(2020年11月12日リリース)¶
誤りを修正する¶
#8372:autodoc:autoclassコマンドはSphinx-3.2より遅い
#7727:autosumary:Pythonパケットが記録されていない場合、PycodeErrorを開始します。 __init__. ピイ!
#8350:自動要約:AUTosumary_MOCK_IMPORTSにより構築速度が遅くなります。
#8364:C、空のシンボルの属性を正しく初期化します。
#8399:I 18 N:指定されたパスを構成した後に、システム領域設定パスを配置します。
バージョン3.3.0(2020年11月2日リリース)¶
捨てて使う.¶
sphinx.builders.latex.LaTeXBuilder.usepackages
sphinx.builders.latex.LaTeXBuilder.usepackages_afger_hyperref
sphinx.ext.autodoc.SingledispatchFunctionDocumenter
sphinx.ext.autodoc.SingledispatchMethodDocumenter
追加された機能¶
#8100:html:html_static_filesのコピー失敗のために、より良いエラーメッセージを表示します。
#8141:C:追加
maxdepth
選択権.c:alias
入れ子宣言を挿入するには,以下の操作を実行してください.#8081:LaTeX:LaTeXパッケージの追加を可能にする
app.add_latex_package()
.texファイルを書き込むまで#7996:マニュアルページ:追加
man_make_section_directory
マニュアルページに部分ディレクトリを作成するには、以下の操作を実行してください#8289:ePub:epub Builderの使用禁止を許可“重複したTOCエントリの発見”警告
suppress_warnings
それがそうです。#8298:Sphinx-QuickStart:追加
sphinx-quickstart --no-sep
選択権.#8304:sphinx.test:sphinx.testing.fixturesに共通フラグを登録する
#8051:ナポレオン:すべての項目にobjキャラクターを使用して参照
#8050:ナポレオン:申請
napoleon_preprocess_types
全ての分野にCとC++は,重複項が検出されたときに以前に宣言された行番号を表示する.
#8183:doctreeからLaTeXバージョンのみSUBSITION_REFERENCEノードを削除
誤りを修正する¶
#8085:I 18 N:単文ドメインのサポートを追加
#6640:I 18 N:システムメッセージングが上書きできません
#8143:FALSE値をautoc_default_optionsに渡すとautocを開始します:AttributeError
#8103:autooc:functools.cached_propertyはプロパティとして扱われていません。
#8190:autodoc:ある拡張が文書文字列を空行で終端しない文字列に置き換えると、解析エラーが発生します。
#8142:autococ:tying.Genericから派生するクラスの構造関数署名エラー
#8157:注釈が無効な場合Autodoc:TypeError __args__
#7964:autodoc:デフォルト値のタプルはエラーを示します。
#8200:autococ:タイプ別名AutoAttributeの割り込みタイプフォーマット
#7786:autococ:他のファイルで定義されている再ロード方法を検出できません。
#8294:autodoc:単語列 __slots__ 未正確に処理する
#7785:autoc:autoc_type hints=‘None’は再ロード関数に影響を与えません
#8192:ナポレオン:内連文字を含むときに消失する記述
#8142:ナポレオン:Googleスタイル文書のregixサービス拒否の可能性
#8169:LaTeX:LaTeX_ENGINEがPlatexでない場合でもpxjahyperがロードされている
#8215:LaTeX:‘one side’クラス·オプションの結果、警告が生成されます。
#8175:intersphinx:在庫の中断により正規表現によるサービス拒否の可能性
#8277:Sphinx-Build:構築時コンソールの欠落および余分なスペースの出力(など)
#7973:imgConverter:imagemagickの可用性を複数回チェック
#8255:py domain:デフォルトパラメータ値の数字を16進数から10進数に変更
#8316:HTML:ボタン要素がフォーカスされた場合、矢印キーによるページの変更を防止します。
#8343:HTML検索:解析文書を修復する際に不要な画像ロード
#8254:HTMLトピック:行番号とコード行が一致しない
#8093:いくつかのビルダ(laex、singlehtmlなど)における警告の位置エラーを強調表示します。
#8215:片面ドキュメントを削除するFancyhdr生成警告
#8239:インデントされている場合、ProductionListにトークンを参照することができません。
#8268:リンクチェック:HTTPエラーを報告する
linkcheck_anchors
はい。True
#8245:linkcheck:ローカルファイルのソースディレクトリを検討する
#8321:リンクチェック:
tel:
アーキテクチャハイパーリンクはエラーとして検出された#8323:LinkCheck:アーキテクチャをサポートしていないリンクが見つかった場合、ログアウト状態が正しくありません。
#8188:c、欠落した項を内部オブジェクトタイプ辞書に追加し、例えば、Intersphinxがそれらを解析することを阻止する。
C,無名物体をライオンの顔像の間に固定する.
#8270,C++同名の非関数宣言がすでに存在する場合、関数は重複宣言として正しく拒否される。
C.関数パラメータへの参照を修復する.存在しないアンカーではなく関数にリンクする。
#6914:タイトルが付与されていない項目に図面番号が意外に割り当てられています。
#8320:“イントラネット”の行番号を選択不可にする
テストをする¶
#8257:sphinxでの並列構築をサポートします。テストをする
バージョン3.2.1(2020年8月14日リリース)¶
追加された機能¶
#8095:ナポレオン:追加
napoleon_preprocess_types
Numpyスタイル文書文字列のためのタイププリプロセッサを有効にする#8114:CおよびC++は、パラメータおよび限定子の後に関数属性を解析します。
誤りを修正する¶
#8074:ナポレオン:C-extモジュールの処理時に崩壊
#8088:Napoleon:Numpy Style Parametersセクションの“Inline Genal Start-String Without End-String”警告
#8084:Autodoc:KeyErrorは、破損クラスの属性を記録する際に開始されます。
#8091:Autodoc:AttributeError Python 3.5.2のプロパティが記録されているときに開始されます。
#8099:autoc:NameErrorターゲットコードで使用
TYPE_CHECKING
C++,テンプレートテンプレートパラメータの解析を修復し,#7944を修復した.
バージョン3.2.0(2020年8月8日リリース)¶
捨てて使う.¶
sphinx.ext.autodoc.members_set_option()
sphinx.ext.autodoc.merge_special_members_option()
sphinx.writers.texinfo.TexinfoWriter.desc
C、v 3までのスタイルタイプコマンドとロール、およびオプションを解析します。
c_allow_pre_v3
そしてc_warn_on_allowed_pre_v3
それがそうです。
追加された機能¶
#2076:autodoc:オーバーライドメンバ関数で除外メンバの上書きを許可
#8034:autodoc:
:private-member:
記録するメンバ名の明示的なリストを取得することができる#2024:自動要約:追加
autosummary_filename_map
大文字の異なる2つのオブジェクト間のファイル名の衝突を避ける#8011:自動要約:自動集約コマンドの対象としてインスタンス属性をサポートする
#7849:HTML:追加
html_codeblock_linenos_style
コードブロックの行番号パターンを変更するステップ#7853:CおよびC++、パラメータ化されたGNUスタイル属性をサポートします。
#7888:ナポレオン:別名を追加し、警告して向上させる。
#7690:ナポレオン:タイプ文字列を解析し、可能な限りハイパーリンクにします。換算規則は通過することができる
napoleon_type_aliases
#8049:ナポレオン:以下の場合、パラメータタイプごとにハイパーリンクを作成します。
napoleon_use_params
偽物だよ。C、追加
c:alias
既存の宣言コピーを挿入するための命令。#7745:HTML:文書名にスペースが含まれている場合、在庫が中断されます。
#7991:HTML検索:数字の検索を許可する
#7902:HTMLトピック:新しいオプションの追加
globaltoc_maxdepth
側辺欄でglobaltocの行動を制御する#7840:I 18 N:ブート依存性チェックの最適化
#7768:I 18 N:
figure_language_filename
支持台.docpath
トークン.#5208:リンクチェック:ローカルリンクのサポートチェック
#5090:setuptools:distutilsの-vおよび-qオプションに詳細をリンクする
#6698:doctest:追加
:trim-doctest-flags:
そして:no-trim-doctest-flags:
Doctest,testcode,testoutputコマンドのためのオプション#7052:追加
:noindexentry:
Python、C、C++およびJavascriptドメインに追加します。このオプションをよりよく反映するためにドキュメントを更新します:noindex:
選択します。#7899:c、v 3以前のパターンタイプ命令およびロールを解析する可能性を追加し、それらを等価なv 3命令/ロールに変換することを試みる。新しいオプションを設定する
c_allow_pre_v3
至るTrue
これを実現することができますこの機能を設定することで、機能印刷からの警告をキャンセルすることができますc_warn_on_allowed_pre_v3
では. ``True`
それがそうです。この機能はただちに破棄される.#7999:c、名前可変マクロパラメータのサポートを追加します。
#8071:“自己参照ディレクトリツリー”の抑制を許可する警告
誤りを修正する¶
#7886:汎用タイプのクラスをシミュレートする際にautodocを誘発する:TypeError
#7935:autodoc:関数のパラメータが
inspect._empty
デフォルト値として#7901:再ロード関数を解析していないautodoc:タイプ書き込み
#904:automoc:インスタンス属性によるautofunction命令の崩壊
#1362:autodoc:
private-members
オプションはクラス属性には適用されません#7983:autodoc:py 36でエラーレンダリング生成器タイプの書き込み
#8030:autoc:初期化されていない注釈付きインスタンス変数は、以下の場合には記録されていません。
:inherited-members:
提供されたオプション#8032:autodoc:派生クラスの文書に親クラス定義が表示されていないインスタンス変数のタイプ提示
#8041:autodoc:派生クラスに他の注釈付きインスタンス変数がある場合、スーパークラス上の注釈付きインスタンス変数は記録されていない
#7839:自動要約:関数名の変音を扱うことができません
#7865:自動要約:略語を発見した場合、バスの総行の抽出に失敗しました。
#7866:自動要約:文書文字列にハイパーリンク先が含まれている場合、正しい要約行を抽出することができません
#7469:自動要約:“Module Attributes”ヘッダは翻訳できません
#7940:apidoc:モジュールにサブモジュールがある場合、rstファイルの末尾に追加の改行を生成する
#4258:ナポレオン:装飾された特殊な方法を表示していない
#7799:ナポレオン:Numpydocの組み合わせパラメータのパラメータは変換されません。
#7780:Napoleon:Napoleon_use_params=Trueの場合、numpydocの複数のパラメータ宣言を誤認識します。
#7715:ラテックス:
numfig_secnum_depth > 1
誤ったデジタルリンクを引き起こす#7846:HTMLトピック:XML-生成されたファイルが無効です。
#7894:gettext:rst_epilogを使用した場合、エラーを表示するソース情報
#7691:linkcheck:Head要求はチェックに使用されていません。
#4888:I 18 N:明示的なヘッダを追加できません。
:ref:
翻訳の役割について#7928:Pyドメイン:属性を解析できないタイプ書き込み
#8008:Pyドメイン:省略番号を含むタイプの書き込みを分析できません。
#7994:std domain:option命令は、2.x以上のバージョンと互換性のある古いnode_idを生成しません。
#7968:I 18 N:コンテンツ
math
コマンドはREST ON TRANSPECTIONと解釈されます#7768:I 18 N:The
root
の元素figure_language_filename
ユーザが文書で指定した経路ではない#7993:入れ子オブジェクト記述のためのtexinfo:TypeError
#7993:texinfo:desc_sign_lineノードがサポートされていない警告を表示します。
#7869:
abbr
説明されていないロールは、前の略語の説明を表示します#8048:非HTML文書を構築する際にraphviz:raphviz.cssがコピーされています。
CとC++,削除
noindex
それが何もしないので、指示オプション。#7619:ノードに複数のIDがある場合、重複するノードIDが生成される
#2050:トップページに記号部分が2回出現
#8017:sphinx.addnodeにおけるループインポートの修復
#7986:css:“ハイライト”セレクタをよりロバストにする
#7944:C++、依存限定名で始まる非タイプテンプレートパラメータを解析します。
C,枚挙器を処理するたびに符号表全体を深さコピーしてめちゃくちゃにしないようにする.
バージョン3.1.2(2020年7月5日リリース)¶
互換性のない変更¶
#7650:autoc:修飾関数は修飾子署名ではなく基底関数署名を表示する
誤りを修正する¶
#7844:autodoc:相対モジュール名が与えられたとき、モジュールが失敗したことを検出します。
#7856:autoclassコマンドに非クラスオブジェクトを提供する場合、autodocを開始する:AttributeError
#7850:autoc_type hintsが‘description’の場合、無効フラグによりautoc:KeyErrorが誘発されます。
#7812:autodoc:ターゲット名が同名のプロパティおよびモジュールと一致する場合、クラッシュ
#7650:autodoc:関数署名変更
(*args, **kwargs)
関数が汎型修飾器によって修飾されていれば#7812:自動要約:ターゲットコードに同名の属性およびモジュールが含まれている場合、破損したスタブファイルが生成されます。
#7806:ビューコード:サードパーティ生成器上のビューコード参照を解析できません。
#7838:HTMLトピック:リストエントリには追加の垂直空間があります。
#7878:HTMLトピック:“overflow”と“Float”の間で不要なインタラクション
バージョン3.1.1(2020年6月14日リリース)¶
互換性のない変更¶
#7808:ナポレオン:属性のタイプは類型化フィールドとして表現されます。
追加された機能¶
#7807:autodoc:TYPE_COMMENTがその署名と一致しない場合に詳細な警告が表示されます。
誤りを修正する¶
#7808:autodoc:変数および属性タイプの書き込み開始警告
#7802:Autodoc:EOFError並列構築時に開始
#7821:C-ext関数の再ロードによるautoc:TypeError
#7805:AutoDoc:ディスクリプタが返されたオブジェクトの意外なレコード
#7807:autodoc:contextmanagerの関数を使用してエラー署名を表示する
#7812:自動要約:ターゲットコードに同名の属性およびモジュールが含まれている場合、破損したスタブファイルが生成されます。
#7808:ナポレオン:変数および属性タイプの書き込みによる警告
#7811:sphinx.utill.checkによるループインポートの問題
バージョン3.1.0(2020年6月8日リリース)¶
依存性.¶
#7746:mathjax:2.7.5に更新
互換性のない変更¶
#7477:imgConverter:Windowsデフォルトで“magick Convert”コマンドを呼び出す
捨てて使う.¶
Sphinx.ext.autosummary.Generate.AutosummaryRenenderの最初のパラメータは、Sphinxオブジェクトに変更されました
sphinx.ext.autosummary.generate.AutosummaryRenderer
対象タイプをパラメータとする♪the
ignore
論争する.sphinx.ext.autodoc.Documenter.get_doc()
♪the
template_dir
論争する.sphinx.ext.autosummary.generate. AutosummaryRenderer
♪the
module
論争する.sphinx.ext.autosummary.generate. find_autosummary_in_docstring()
♪the
builder
論争する.sphinx.ext.autosummary.generate. generate_autosummary_docs()
♪the
template_dir
論争する.sphinx.ext.autosummary.generate. generate_autosummary_docs()
♪the
ignore
論争する.sphinx.util.docstring.prepare_docstring()
sphinx.ext.autosummary.generate.AutosummaryRenderer.exists()
sphinx.util.rpartition()
追加された機能¶
ラテックス:製造
toplevel_sectioning
LaTeXトピックの設定はオプションLaTeX:LaTeXトピックの紙のサイズとポンド値をカバーすることができます
LaTeX:追加
latex_theme_options
トピック·オプションを上書きするには、以下の操作を実行してください#7410:キャンセル表示“ループディレクトリツリー参照の検出”警告の使用が許可されます。
suppress_warnings
C, added scope control directives,
c:namespace
,c:namespace-push
, andc:namespace-pop
.#2044:autodoc:インスタンス属性のデフォルト値を禁止する
#7473:autodoc:docstringが含まれている場合
:meta public:
INFO-FIELD-LISTでは#7487:autodoc:py:autofunctionによる単発関数の生成を許可する伝票
#7143:autodoc:最終クラスおよびメソッドをサポート
#7384:autodoc:定義された署名をサポート
__new__()
元、内蔵ベース#2106:autodoc:docstringでの複数の署名をサポート
#4422:autococ:Python 3.7以上のバージョンをサポートするGenericAlias
#3610:autodoc:再ロード関数をサポート
#7722:autodoc:TypeVarをサポート
#7466:自動要約:生成された文書のタイトルは翻訳されません
#7490:自動要約:追加
:caption:
ディレクトリツリーのタイトルを設定するためのコマンドを自動集約するオプション#7469:自動集約:サポートモジュールのプロパティ
#248、#6040:自動要約:追加
:recursive:
コマンドを自動集約するオプション、スタブファイルを再帰的に生成するための#4030:自動要約:追加
autosummary_context
カスタムテンプレートのテンプレート変数を追加するには、以下の操作を実行してください#7530:HTML:入れ子<kbd>要素をサポート
#7481:HTMLトピック:脚注/参照タグに右ページのエッジ距離を追加する
#7482,#7717:HTMLトピック:タイトルおよびライン番号付きコードブロックのCSS間隔
#7443:HTMLトピック:新しいオプションの追加
globaltoc_collapse
そしてglobaltoc_includehidden
側辺欄でglobaltocの行動を制御する#7484:HTMLトピック:サイドバーと他のブロックとの間の衝突を回避
#7476:HTMLトピック:Relbar breadcrumbには現在のページが含まれる必要があります。
#7506:HTMLトピック:仕様のURLが変換されていません。
#7533:HTMLトピック:genindex.htmlの先頭のスペースを避ける
#7541:HTMLトピック:Bodyの末尾により明確なものを追加する
#7542:HTMLトピック:警告/トピック/サイドバーをスクロール可能にする
#7543:HTMLトピック:上と下の距離をフォームに追加する
#7695:HTMLトピック:基本トピックにビューポート·メタ·タグを付加する
#7721:HTMLトピック:クラシック:デフォルトcodebgcolor/codebgcolor Pygmentsを上書きしません。
CとC+:宣言の末尾に記号の使用が許可されています。
C++は,パラメータ化された非異常説明子を解析する.
#7294:C++、ユーザ定義の文字解析式を使用します。
C++,トレースバックパターンを解析する.
#7143: py domain: Add
:final:
option topy:class:
,py:exception:
andpy:method:
directives#7596:Pyドメイン:変数のタイプ書き込みをハイパーリンクに変更します。
#7770:標準ドメイン名:
option
フォーマットのコマンドサポートパラメータfoo[=bar]
#7582:ナポレオン:属性のタイプ表現は、タイプ注釈と同様である
#7734:ナポレオン:属性上の過転義尾部に下線を引く
#7247:リンクチェック:追加
linkcheck_request_headers
特定ホストのカスタムHTTPヘッダを送信するには、以下の操作を実行してください#7792:setuptools:サポート
--verbosity
選択権.#7683:追加
allowed_exceptions
パラメータが到着するSphinx.emit()
処理プログラムが指定された異常を引き起こすことを許可する#7295:C++、解析(尾行)には節が必要です。
誤りを修正する¶
#6703:autodoc:インクリメンタル構築導入対象には適用できません。
#7564:autodoc:ディスクリプタは書き込みを表示しません。
#6588:autodoc:修飾された継承方法にドキュメントがない
#7469:autodoc:変数のautoc-process-docstring変更意外なキャッシュ
#7559:autodoc:同期機能が非同期であることを誤検出
#6857:autococ:Enumクラスでクラスメソッドが検出されなかった
#7562:autococ:autoc_type hints=‘description’モードでスペースを含むタイプのプロンプトを誤って表示する
#7551:autodoc:ネストクラスの導入ができません
#7362:autodoc:内蔵関数に正しい署名が提示されていません
#7654:AutoDoc:
Optional[Union[foo, bar]]
と表す.Union[foo, bar, None]
#7629:autodoc:指定されたオブジェクトが無効である場合、autofunctionは非友好的な警告を発します。
#7650:autodoc:修飾関数表示未修飾署名
#7676:autodoc:AUTODOC_MEMBER_ORDERデフォルト値におけるスペルエラー
#7676:autodoc:エラー値:Member-Order:オプションが暗黙に無視される
#7676:autodoc:ember-order=“bysource”はCモジュールには適用されません。
#3673:autococ:ember-order=“bysource”は使用できません。 __all__
#7668:autodoc:誤ったRetann値をautoc-process-signに渡すハンドラ
#7711:autodoc:Numpyオブジェクトの処理に失敗し、ValueErrorに戻ります。
#7791:単発関数を記録する際にautocを誘発する:TypeError
#7551:自動要約:入れ子クラスは非入れ子クラスにインデックスされます。
#7661:自動集約:ターゲットモジュールの導入に失敗すると、自動集約コマンドが2回警告されます。
#7685:自動集約:テンプレート変数“Members”には、導入されたメンバが含まれていても
autossummary_imported_members
偽物だよ。#7671:自動要約:失敗警告の導入が不足している場所
#7535:Sphinx-Autogen:カスタムテンプレートが継承を使用した場合に崩壊します。
#7536:Sphinx-Autogen:テンプレートがI 18 N機能を使用すると崩壊します。
#7781:spinx-build:outdirがディレクトリでない場合、エラーメッセージが発生します。
#7653:Sphinx-QuickStart:ネストrelpathを修復する複数のディレクトリ作成
#2785:HTML:公式リンク整列エラー
#7718:HTMLトピック:Pygmentsスタイルの背景色(agogo、haiku、Nature、ピラミッド、リール、ライオンイメージ、伝統を尊重しないトピック)
#7544:HTMLトピック:警告のフィラーが一致しません。
#7581:ナポレオン:属性文書文字列の内部接続コード解析エラー
#7628:imgConverter:画像をサポートしないビルダに対して、imagemagickを一度に実行することは不要です。
#7610:docutilsを正しく表示しない連続逆スラッシュ-0.16
#7646:イベントハンドラのエラーを処理する
#4187:LaTeX:en dashは日本語文書のPDFブックマークから消えます
#7701:LaTeX:匿名間接ハイパーリンクターゲットによるラベル重複
#7723:URLにシングル引用符が含まれている場合、LaTeX:pdflatexが崩壊する
#7756:PYドメイン:位置パラメータのみのデフォルト値は表示されていません。
#7760:上書き範囲:追加
coverage_show_missing_items
コンソールに上書き結果を表示するには、以下の操作を実行してくださいC++、修復入れ子名の中で明示的にグローバルスコープからのレンダリングおよび外部参照、例えば、
::A::B
それがそうです。C,修復入れ子名のうちグローバルスコープから明示的に開始されるレンダリングおよび外部参照,たとえば,
.A.B
それがそうです。#7763:CおよびC++は、1つの要素式および折り畳み式の文字列を表示する際に崩壊しません。
バージョン3.0.4(2020年5月27日リリース)¶
誤りを修正する¶
#7567:autodoc:汎タイプのパラメータ化タイプを2回表示
#7637:autodoc:Python 3.9には、システム定義のTypeVarsが表示されています。
#7696:HTML:セキュリティ上、jQueryバージョンは3.4.1から3.5.1に更新されます。
#7611:OpenSSL FIPSを有効にした場合MD 5に失敗
#7626:バージョンのパケットには含まれていません
CODE_OF_CONDUCT
バージョン3.0.3(2020年4月26日リリース)¶
追加された機能¶
C,配列宣言子は静的,限定子,VLA仕様を用いて解析する.
誤りを修正する¶
#7516:autodoc:ターゲットオブジェクトが属性にアクセスしたときにエラーが発生した場合、クラッシュ
バージョン3.0.2(2020年4月19日リリース)¶
追加された機能¶
C、属性を解析して追加
c_id_attributes
そしてc_paren_attributes
ユーザ定義の属性をサポートする.
誤りを修正する¶
#7461:Pyドメイン:タイプ書き込みの空のタプルが失敗し、IndexErrorを返します。
#7510:Pyドメイン:ドキュメントにキーワードのみが含まれているパラメータのデフォルト値はNoneです。
#7418:STDドメイン名:
term
キャラクターは大文字と一致できず、大文字を区別しません#7461:autodoc:タイプ書き込みの空き要素グループが正しく表示されていません。
#7479:autodoc:Sphinxバージョン3.0.0から模倣が遅くなりました。
C++,East-Const宣言中のスペース問題を修復した.
#7414:LaTeX:XINDY言語オプションが正しくない
ImportErrorのSphinx崩壊がPython 3.5.1に現れた
バージョン3.0.1(2020年4月11日リリース)¶
互換性のない変更¶
#7418:STDドメイン名:
term
役が小文字を区別するようになる
誤りを修正する¶
#7428:Pyドメイン:クラスへの参照
None
難癖のある警告を発する#7445:Pyドメイン:注釈を返す
None
関数にintersphinxを用いた場合,署名はハイパーリンクに変換されない.#7418:標準ドメイン:用語の重複警告サイズを区別しない
#7438:C++、並列構築で過負荷関数を統合する問題が修復されました。
#7422:autodoc:autoc_mock_Importsの使用に失敗し、ValueErrorに戻ります。
#7435:自動ドッキング:
autodoc_typehints='description'
クラス/メソッドを隠蔽しない署名におけるタイプ提示#7451:オブジェクトが非文字列オブジェクトを属性として返すと、autodoc:失敗してAttributeErrorを返す
__doc__
会員#7423:非文字列オブジェクトがレコーダに提供されるとクラッシュします。
#7479:HTMLトピック:HTML 5ドキュメントタイプにxmlns属性が含まれていない
#7426:HTMLトピック:HTMLテンプレートのいくつかのリンクを変換する
バージョン3.0.0(2020年4月6日リリース)¶
依存性.¶
3.0.0b1
LaTeX:依存を放棄する extractbb 日本語文書に含まれる画像については,以下のようになる.
.xbb
以下の項目はファイルを必要としない dvipdfmx TeXLive 2015以来(参考文献:#6189)バーベルタ-2.0以降を提供する(固定されていない)
互換性のない変更¶
3.0.0b1
1.8.xで推奨されていない機能やAPIの削除
#247:自動集約:デフォルトの場合は自動的にスタブファイルを上書きします。見
autosummary_generate_overwrite
行動を変更するには、以下の操作を実行してください#5923:autodoc:メンバー
object
デフォルトの場合、以下の場合はクラスを記録しません:inherited-members:
そして:special-members:
全部出しました。#6830:PYドメイン名:
meta
INFO-FIELD-LIST中のフィールドは保留状態となる.出力文書には表示されません#6417:pyドメイン:desc_parameterlistのdoctreeが変更されました。パラメータ名、書き込み、およびデフォルト値は、イントラネットノードでパッケージされています。
構造物.
sphinx.events.EventManager.listeners
もう変わった以下の項のスコープ変更により
productionlist
いくつかの使い方token
以前無視していたスコープを含むように修正しなければならない.#6903:Python、REST、および標準ドメイン名の内部データ構造が変更されました。Node_idをオブジェクトとモジュールのインデックスに追加する.今,それらは交差参照のためのdocnameとnode_idの対を含む.
#7276:C++ドメイン:予期しないアクション、例えば削除
say_hello_
リンクしています.. cpp:function:: say_hello()
#7210:jsドメイン:予期しないアクションを削除する、例えば
parseInt_
リンクしています.. js:function:: parseInt
#7229:RSTドメイン:予期しないアクションを削除し、例えば
numref_
リンクしています.. rst:role:: numref
#6903:Pyドメイン:予期しないアクションを削除する、例えば
say_hello_
リンクしています.. py:function:: say_hello()
#7246:Pyドメイン:例外、関数、および方法を削除する特別な交差参照ヘルプ
Cフィールドは書き換えられており,他の命令やロールが追加されている.既存の規制はもうもっと厳しくなって、新しい警告を生み出している。
この属性は
sphinx_cpp_tagname
はい。desc_signature_line
ノードは名前を変えましたsphinx_line_type
それがそうです。#6462:デフォルトの場合、ドメイン命令内の二重逆スラッシュは、もはやモノバックスラッシュに置換されない。新しい構成値
strip_signature_backslash
ユーザはそれを再有効にするために使用することができる。
3.0.0最終バージョン
#7222:
sphinx.util.inspect.unwrap()
改名しました。unwrap_all()
捨てて使う.¶
3.0.0b1
desc_signature['first']
sphinx.directives.DescDirective
sphinx.domains.std.StandardDomain.add_object()
sphinx.domains.python.PyDecoratorMixin
sphinx.ext.autodoc.get_documenters()
sphinx.ext.autosummary.process_autosummary_toc()
sphinx.parsers.Parser.app
sphinx.testing.path.Path.text()
sphinx.testing.path.Path.bytes()
sphinx.util.inspect.getargspec()
sphinx.writers.latex.LaTeXWriter.format_docclass()
追加された機能¶
3.0.0b1
#247:自動集計:追加
autosummary_generate_overwrite
古い控えファイルを上書きするには、以下の操作を実行してください#5923:autodoc:
:inherited-members:
オプションは、継承されたクラスメンバおよび上流を記録しないように、アンカークラスの名前を採用する#6830:autodoc:docstringが含まれている場合
:meta private:
INFO-FIELD-LISTでは#7165:AutoDoc:注釈タイプ(PEP-593)をサポート
#2815:autoc:単一スケジューリング関数および方法をサポート
#7079:autodoc:
autodoc_typehints
受け入れる"description"
配置します。これは、オブジェクト記述としてタイプ提示を表示します。#7314:apidoc:伝播
--maxdepth
小包文書の閲覧を選択できます#6558:語彙表:重複する語彙表のエントリに警告を出す
#3106:ドメイン名:ホームハイパーリンク先の自動登録
#6558:標準ドメイン:重複する汎用オブジェクトに警告を発する
#6830:PYドメイン名:新しいイベントの追加:
object-description-transform
#6895:Pyドメイン:内蔵タイプに難癖をつけない警告
Pyドメイン:関数署名でlambda関数をサポートする.
#6417:pyドメイン:関数およびメソッドのパラメータのスタイル設定を可能にする
#7238,#7239:Pyドメイン:エントリが同じ名前で追加された場合、Pythonオブジェクトを記述する際に警告が発行されます。
#7341:PY DOMAIN:単語のタイプの書き込みを交差参照に変換する
イベントハンドラの優先度をサポートする.詳細については、ご参照ください
Sphinx.connect()
#3077:実装されたスコープ
productionlist
文書に示すように.#1027:継続中の逆スラッシュをサポート
productionlist
それがそうです。#7108:config:conf.pyからのエラーメッセージの表示を許可する
ConfigError
#7032:HTML:
html_scaled_image_link
以下の属性を持つ画像に対して無効になりますno-scaled-link
クラス#7144:Descノードごとにドメイン名を表すCSSクラスを追加する
#7211:LaTeX:XeLaTeXを使用する場合、中国語文書にバベルタを使用する
#6672:LaTeX:LaTeXトピックをサポート(実験)
#7005:LaTeX:LaTeXスタイルマクロの追加
kbd
役柄#7220:genindex:Mainインデックスを最初に表示する
#7103:リンクチェック:すべてのリンクを書き込む
output.json
#7025:HTML検索:以下のコマンドを使用して、単一の文書に対して全文検索を無効にすることができます。
:nosearch:
文書範囲のメタデータ#7293:HTML検索:JavaScript分解器を以下のように上書きすることができます。
SearchLanguage.js_splitter_code
#7142:HTMLトピック:トピックオプションの追加:
pygments_dark_style
ダークモードでコードブロックのパターンを切り替えるには、以下の操作を実行してくださいCフィールドは書き換えられ、例えば:
現在の範囲に関する交差引用.
匿名エンティティを記録することができる.
各エンティティタイプのより具体的な命令およびロール、例えば、列挙数を処理するスコープ。
新しい役.
c:expr
表現およびタイプをテキストに提示するために使用される。
増列する.
SphinxDirective.get_source_info()
そしてSphinxRole.get_source_info()
それがそうです。#7324:Sphinx-Build:同じ文書が異なるファイル拡張子を有する複数のファイルが発見された場合、警告を発する
3.0.0最終バージョン
増列する.
ObjectDescription.transform_content()
それがそうです。
誤りを修正する¶
3.0.0b1
C++では、関数の再ロードに関する場合によっては交差参照ルックアップが修復されます。
#5078:C++、修復命令が複数の宣言を含む場合の交差参照ルックアップ。
C++では,署名中に自動生成された交差参照中の直接依存タイプ名への警告を禁止する.
#5637:autodoc:ネスト·クラス名が正しく処理されていないことを表示する
#7267:autodoc:無効命令オプションのエラーメッセージ位置エラー
#7329:クラス記述のタイプ提示からautodoc:info-field-listを誤って生成する
autoclass_content='class'
集#7331:autodoc:cython関数は関数として識別されていません。
#5637:継承_グラフ:ネスト·クラス名が正しく処理されていない
#7139:
code-block:: guess
役に立たない#7325:html:source_Suffixには、誤ったソースリンクが含まれています。
#7357:HTML:SVG画像サイズの調整に失敗し、ValueErrorを返します。
#7278:HTML検索:修復
html_file_suffix
ではなくhtml_link_suffix
検索結果では#7297:HTMLトピック:
bizstyle
支持しないsidebarwidth
#3842:singlehtml:master docがsource rootにない場合、イメージパスが中断されます。
#7179:標準ドメイン:GenericObjectの参照を修復する際にスペースの使用を禁止する問題
#7289:コンソール:太字ではなく鮮やかな色を使用
#1539:C、配列タイプを解析します。
#2377:C、複雑なタイプでも関数ポインタを解析します。
#7345:Sphinx-Build:出力ディレクトリがファイル形式で存在する場合、Sphinxが崩壊します。
#7290:Sphinx-Build:bdb.BdbQuitを無視する例外処理
#6240:ナポレオン:属性およびメソッド部分無視:noindex:オプション
3.0.0最終バージョン
#7364:自動要約:以下の場合にクラッシュ
autosummary_generate
偽物だよ。#7370:自動要約:未知のモジュールが与えられたときにUnbound LocalErrorを開始する
#7367:C++、置換演算子スペルがサポートされます。
C,現在バックアップ演算子スペルをサポートしている.
#7368:C++、式中のコンマ演算子、テンプレートパラメータリスト内のパケット展開、および場合によってはより包括的なエラーメッセージ。
C++は,無名記号に関する崩壊と誤りの重複警告を修復した.
#6477:先に逃げる!交差引用リンクでは不可能になりました
#7219:py domain:生成されたインデックス項目
py:function
指令と指令が違うindex
“Builtin”タイプのコマンド#7301:node_id大文字は許可されていません
#7301:ePub:重複node_idの生成
#6564:HTML:HTML生成器ではフォーム幅を無視しています。
#7401:転送のためのパラメータが正しくない
env-get-outdated
処理プログラム.#7355:autodoc:cython-functionをうまく識別できない署名
#7222:autodoc:
__wrapped__
未正確記録関数#7409:intersphinx:ValueErrorは拡張の設定時に開始されます。
intersphinx_mapping
開けるconfig-inited
事件#7343:デバッグモードでは、Sphinx構築が2.4.0から遅くなる
バージョン2.4.4(2020年3月05日リリース)¶
誤りを修正する¶
#7197:LaTeX:Platexがターゲットurlを使用してイメージコマンドを生成した場合のエラー
#7223:2.4.0からSphinxの構築速度が遅くなりました
バージョン2.4.3(2020年2月22日リリース)¶
誤りを修正する¶
#7184:自動ドッキング:
*args
そして**kwarg
未処理タイプの注釈#7189:autoc:classmethodプロトコルが検出されていません。
#7183:ライオンのイメージ:
:attr:
属性への引用は中断された#6244、#6387:HTML検索:dirhtml生成器を用いて構築された場合の検索中断/保留
#7195:TODO:非文書ノードを用いてdoctree解析を誤って発行したイベント
バージョン2.4.2(2020年2月19日リリース)¶
誤りを修正する¶
#7138:autodoc:
autodoc.typehints
変数が束縛されていないオブジェクトを値とした場合に崩壊する.#7156:autodocが表示されていない:キーワードパラメータのみの区切り
#7146:抑制されたTYPE_COMMENTが発見された場合、autoc:IndexErrorを誘発します。
#7161:autodoc:type hints拡張では並列構築はサポートされていません
#7178:タイプ書き込みの取得時にautocを誘発する:TypeError
#7151:拡張によって値が与えられたときに崩壊します。
env.indexentries
#7170:Text:デバッグ印刷の削除
#7137:viewcode:非pythonコードが与えられたときのクラッシュを避ける
バージョン2.4.1(2020年2月11日リリース)¶
誤りを修正する¶
#7120:HTML:浮動サイズのSVG画像をスケーリングすると崩れます。
#7126:autodoc:TypeError:‘getset_description ptor’オブジェクトは反復できません。
バージョン2.4.0(2020年2月9日リリース)¶
捨てて使う.¶
♪the
decode
論争する.sphinx.pycode.ModuleAnalyzer()
sphinx.directives.other.Index
sphinx.environment.temp_data['gloss_entries']
sphinx.environment.BuildEnvironment.indexentries
sphinx.environment.collectors.indexentries.IndexEntriesCollector
sphinx.ext.apidoc.INITPY
sphinx.ext.apidoc.shall_skip()
sphinx.io.FiletypeNotFoundError
sphinx.io.get_filetype()
sphinx.pycode.ModuleAnalyzer.encoding
sphinx.roles.Index
sphinx.util.detect_encoding()
sphinx.util.get_module_source()
sphinx.util.inspect.Signature
sphinx.util.inspect.safe_getmembers()
sphinx.writers.latex.LaTeXTranslator.settings.author
sphinx.writers.latex.LaTeXTranslator.settings.contentsname
sphinx.writers.latex.LaTeXTranslator.settings.docclass
sphinx.writers.latex.LaTeXTranslator.settings.docname
sphinx.writers.latex.LaTeXTranslator.settings.title
sphinx.writers.latex.ADDITIONAL_SETTINGS
sphinx.writers.latex.DEFAULT_SETTINGS
sphinx.writers.latex.LUALATEX_DEFAULT_FONTPKG
sphinx.writers.latex.PDFLATEX_DEFAULT_FONTPKG
sphinx.writers.latex.XELATEX_DEFAULT_FONTPKG
sphinx.writers.latex.XELATEX_GREEK_DEFAULT_FONTPKG
追加された機能¶
#6910:引継ぎ_グラフ:チャートの背景を透明にする
#6446:時間:追加
sphinx.ext.durations
どの文書が構築速度を遅くしているかをチェックするには、以下の操作を実行してください#6837:LaTeX:入れ子テーブルをサポート
#7115:LAXEX:LATEXOPTSとLATEXMKOPTSを環境変数で上書きすることを許可
#6966:raphviz:サポート
:class:
選択権.#6696:HTML:
:scale:
画像/グラフィックス命令オプションは、SVG画像には適用できません(ImageSize-1.2.0以降が必要)#6994:imgConverter:Illustratorファイル(.ai)から.pngへの変換をサポート
Autodoc:位置パラメータのみのセパレータ(PEP-570準拠)をサポート
Autodoc:変数をサポートするタイプのアノテーション
#2755:autodoc:新しいイベントを追加:
autodoc-before-process-signature
#2755:autoc:TYPE_COMMENTスタイル(例えば、サポート)
# type: (str) -> str
)書き込み(python 3.8+または typed_ast 必須項にする#7051:autoc:デフォルト値をサポートしないインスタンス変数(PEP-526)
#6418:autodoc:新しい拡張子の追加
sphinx.ext.autodoc.typehints
それがそうです。以下の条件を満たす場合は,カテゴリ提示をオブジェクト記述として表示する.autodoc_typehints = "description"
準備ができました。これはSphinx-3.0のAutoDocコアに統合される試験的拡張ですオリジナルノードクラスの訪問者/離脱方法が見つからなければ,SphinxTranslatorは現在スーパーノードクラスの訪問者/離脱方法を呼び出す.
#6418:新しいイベントを追加:
object-description-transform
PYドメイン:
py:data
そしてpy:attribute
名前の新しいオプションを選択する:type:
そして:value:
その種類と初期値を説明します#6785:PYドメイン名:
:py:attr:
属性を再引用することができる#6772:apidoc:追加
-q
サイレント·モード·オプション
誤りを修正する¶
#6925:HTML:<script>要素からの冗長type=“text/javascript”の削除
#7112:HTML:SVG画像は整列してもフローティングにレイアウトされません。
#6906,#6907:autodoc:cp 1251符号化されたソースコードの読み込みに失敗しました。
#6961:LaTeX:バ別塔への警告表示2回
#7059:LaTeX:LaTeXコンパイルは無限ループ(パッケージ問題)に陥っています。
#6581:LaTeX:
:reversed:
ToctreeオプションはLaTeX構築に影響を与えない#6559:語彙表命令でエラーが生成されたノードID
#6986:apidoc:エラー検出モジュール内.soファイルのモジュール名
#6899:apidoc:プライベートメンバは表示されません。
--private
vt.与えられる.#6327:apidoc:以下を含むpythonパケットをサポート __init__. SOファイル
#6999:ナポレオン:解析不能:exc:Roleの波記号
#7019:gettext:メールディレクトリで使用される絶対パス
#7023:autodoc:入れ子の部分関数はリストされていません。
#7023:autodoc:他のモジュールから導入された部分関数をモジュールメンバとしてリストし、なし:impoprted-Members:オプション
#6889:autodoc:尾行コンマ
:members::
選択肢があいまいな警告を招く#6568:自動要約:
autosummary_imported_members
サブモジュールのスタブファイルを生成する際には無視される.#7055:リンクチェック:リダイレクトはエラーとみなされます。
#7088:HTMLテンプレート:IF
navigation_with_keys
オプションがアクティブ状態の場合,修正キーを無視することは,その要素がブラウザ要素に干渉する可能性があることを意味する.#7090:標準ドメイン:カスタムコンテナノードにnumfig-numberを割り当てることができません。
#7106:標準ドメイン:拡張呼び出し時の枚挙ノードは重複としてラベル付けされています。
note_explicit_target()
#7095:dirhtml:intersphinxと
:doc:
役柄C++:
使うときは崩れないでください
struct
場合によっては機能する。使用時には警告を出さない
var
/member
関数パラメータの役割。呼び出しと括弧付きの初期化式を正しく提示する.
#7097:生成されたミラーファイル名
sphinx.transforms.post_transforms.images.ImageConverter
あるいはそのサブクラス(LaTeX構築用)は経路切断を防ぐためにクリーニングを行っている.
バージョン2.3.0(2019年12月15日リリース)¶
互換性のない変更¶
#6742:
end-before
オプションliteralinclude
命令は、コードブロックの1行目と一致しない。#1331:デフォルトUser-Agentヘッダを変更する
"Sphinx/X.Y.Z requests/X.Y.Z python/X.Y.Z"
それがそうです。これは以下のように変更できますuser_agent
それがそうです。#6867:text:空いている行から警告内容が開始されます。
捨てて使う.¶
sphinx.builders.gettext.POHEADER
sphinx.io.SphinxStandaloneReader.app
sphinx.io.SphinxStandaloneReader.env
sphinx.util.texescape.tex_escape_map
sphinx.util.texescape.tex_hl_escape_map_new
sphinx.writers.latex.LaTeXTranslator.no_contractions
追加された機能¶
#6707:C++、ビットフィールドをサポートします。
#267:HTML:doctestブロックの提示文字をコピー可能テキストから削除する
#6548:HTML:OpenSearchが利用可能であれば、お気に入りアイコンを使用してください
#6729:HTMLトピック:Agogoトピックがサポートされています。
rightsidebar
選択権.#6780:PEP-561サポートの追加
#6762:LaTeX:以下の方法で追加のLaTeXパケットをロードすることを可能にする
extrapackages
のキーワードです。latex_elements
#1331:新しい構成変数の追加:
user_agent
#6000:Laex:逆スラッシュがあっても行内文字改行文字
#4186:LaTeX:新しいものとしてupLaTeXをサポート
latex_engine
(実験的)#6812:非並列セキュリティを拡張した場合の警告メッセージ
#6818:複数のリモート在庫のIntersphinxパフォーマンスを向上させます。
#2546:apidoc:.soファイルのサポート
#6798:自動集計:発射
autodoc-skip-member
控えファイルを生成したときの事件#6483:I 18 N:toctree内の明示的なタイトルを翻訳可能にする
#6816:リンクチェック:追加
linkcheck_auth
以下の操作を実行する際に認証情報のオプションを提供するlinkcheck
家を建てる.#6872:リンクチェック:HTTP 308の永続的リダイレクトの処理
#6613:HTML:ノード番号をspanタグに改行する
#6781:gettext:追加
gettext_last_translator' and :confval:
Gettext_language_team`POTファイルヘッダのカスタマイズ
誤りを修正する¶
#6668:LaTeX:タイトル前の長いテーブルの距離が正しくありません(参照: latex3/latex2e#173 )
#6618:LaTeX:ページ末尾でのノード名の使用を避ける
#6738:LaTeX:UNICODEをサポートするLaTeXエンジンでは、UNICODE文字をLaTeXマクロで置き換えない:?,§,EUROW,∞,±,→,゚,-,添字,添字数字はそのまま経過する(デフォルトOpenTypeフォントはそれらをサポートする).
#6704:Linkcheck:防御性、新たに定義されたHTTPエラーコードの処理
#6806:リンクチェック:解析に失敗しました。
#6655:ピクチャアドレスに含まれる
data:
Gettextビルダの崩壊を引き起こす#6584:I 18 N:ヒンディー語メッセージ·ディレクトリのコンパイル時エラー
#6718:I 18 N:節タイトルと表タイトルが同じであれば、KeyErrorを誘発する
#6743:I 18 N:
rst_prolog
翻訳を中断する#6708:Mathbase:推奨されていない関数のいくつかが削除されました
#6709:autodoc:アナログオブジェクトはクラス修飾器として動作しません。
#5070:ePub:誤った内部HREFフラグメントリンク
#6712:sphinx.testをランタイムとしてインストールしないことが許可されています(主にalt Linux用)
#6741:HTML:検索結果が空
html_file_suffix
#6001:LaTeXは逆スラッシュ文字では改行されていません
#6804:LaTeX:危険タイプの警告に含まれるコードブロック長が1ページに格納されるのに十分でない場合、PDF構築は中断されます。
#6809:LaTeX:危険タイプ警告のコードブロックはページの下部にあふれやすい
#6793:texinfo:“サイドバー”の後に切断されたコードの例
#6813:Windowsに含まれているドキュメントに孤立した警告を発行します。ありがとう@Drilan
#6850:エラー·オプションを使用したSmartyantsモジュール呼び出しre.sub()を修復します。
#6824:HTML検索:検索語がタイトルに部分的に一致し、同じページ上のテキスト段落に完全に一致している場合、検索にはそのマッチング項目は含まれていません。
#6848:configg.pyは、上書きから拡張をポップアップすることはできません。
#6867:TEXT:折り畳み線上のハイフン単語に追加のスペースを挿入する
#6886:LaTeX:xelatexは、直二重引用符を右カール引用符に変換します(いつ表示されますか
smartquotes
はい。False
)#6890:LaTeX:スマート引用符をオフにしても、PDF出力は、直引用符および連続ハイフンをカール引用符および破折記号に変換します。
#6876:LaTeX:バナーページの著者の複数行の表示エッジにばらつきがあります
#6887:docutils付きSphinx崩壊-0.16 b 0
#6920:Sphinx-Build:エラー強調表示コンソールメッセージ
#6900:ライオンのイメージ-内部バージョン:
-D
選択肢は考慮しない0
そして1
ブル値として
バージョン2.2.2(2019年12月3日リリース)¶
互換性のない変更¶
#6803:pythonのセキュリティ上、MacOSおよびPython 3.8+は並列モードをオフにしています。
誤りを修正する¶
#6776:ラテックス:2019-10-01ラテックス解放中断
sphinxcyrillic.sty
#6815:i 18 N:フランス語、ヒンディー語、中国語、日本語、韓国語の翻訳情報が破壊されました。
#6803:MacOSおよびPython 3.8でのAttributeErrorの同時構築
リリース2.2.1(2019年10月26日リリース)¶
誤りを修正する¶
#6641:LaTeX:未定義の制御シーケンス
\sphinxmaketitle
#6710:LaTeX主要言語としてギリシャ語が正しく構成されていない
#6759:パスが異なるディレクトリにある場合、html静的パスおよび追加パスの検証は、もはやエラーを誘発しません。
バージョン2.2.0(2019年8月19日リリース)¶
互換性のない変更¶
Aapidoc:テンプレートファイルの名前を変更する
.rst_t
HTML:フィールドリストは、メッシュレイアウトごとにスタイルを設定します。
捨てて使う.¶
sphinx.domains.math.MathDomain.add_equation()
sphinx.domains.math.MathDomain.get_next_equation_number()
♪the
info
そしてwarn
の論拠sphinx.ext.autosummary.generate.generate_autosummary_docs()
sphinx.ext.autosummary.generate._simple_info()
sphinx.ext.autosummary.generate._simple_warn()
sphinx.ext.todo.merge_info()
sphinx.ext.todo.process_todo_nodes()
sphinx.ext.todo.process_todos()
sphinx.ext.todo.purge_todos()
追加された機能¶
#5124:Graphviz:
:graphviz_dot:
オプションは改名されました:layout:
#1464:HTML:以下の場合に警告を発行します。
html_static_path
そしてhtml_extra_path
ディレクトリは出力ディレクトリ内にあります#6514:HTML:アクセスを容易にするために入力を検索するためにタグを追加します。
#5602:apidoc:追加
--templatedir
選択権.#6475:追加
override
はいの論点です。app.add_autodocumenter()
#6310:imgath:ジャン
imgmath_use_preview
SVG形式を用いてイントラネット数学画像レンダリングを行うことも可能である#6533:LaTeX:再構成に使用するVISITE_ENUMPATED_LIST()
\sphinxsetlistlabels
#6628:クイックスタート:使用
https://docs.python.org/3/
デフォルト設定の場合intersphinx_mapping
#6419:ライオンのイメージ-Build:再構成の理由
誤りを修正する¶
Pyドメイン:重複した警告がソースコードの位置を指すことはない.
#6499:HTML:Sphinxは更新されません。
html_logo
元のファイルが変更されても#1125:HTMLトピック:古典的なトピックやMacOSではスクロールバーが見えにくい
#5502:リンクチェック:HTTP 503応答をエラーではないとみなす
#6439:生成されたダウンロードリンクを再生可能にする
#6486:破損した拡張がインストールされていると、Unbound LocalErrorが誘発されます。
#6567:autodoc:
autodoc_inherit_docstrings
影響はありません__init__()
そして__new__()
#6574:autodoc:
autodoc_member_order
以下の場合は輸入注文を引用しません'bysource'
注文書#6574:autodoc:変数パラメータおよびキーワードパラメータ欠落タイプ書き込み
#6589:autoc:autoc_type hints=‘None’を使用して問題をフォーマットする
#6605:autodoc:ターゲットコードがカスタムクラス·メソッド·オブジェクトを含む場合、クラッシュ
#6498:自動要約:エラーを使用したAUTTOSUMARY_GENERATE設定が崩れます。
#6507:自動要約:AUTTOSUMMARY_GENERATE設定なしでクラッシュ
#6511:LaTeX:Sphinx 1.8.0以降、LaTeXでは自動番号リストをカスタマイズできません(参照:#6533参照)
#6531:拡張を追加すると、最後の環境オブジェクトのロードが失敗します。
#736:ペアインデックスの順序付けが無効
#6527:
last_updated
誤ってタイムゾーンをUTCと仮定する.#5592:標準ドメイン名:
option
指示は、各コンマ分割オプションにインデックス項目を登録する#6549:Sphinx-Build:エラーメッセージの転送文字
#6545:doctest注釈がトリミングされていないSphinx 1.8.0以来
#6561:語彙表:非英数字タームの誤ったハイパーリンクを生成する
#6620:I 18 N:定義リストの分類子はdocutils-0.15翻訳を使用しない
#6474:
DocFieldTransformer
所与の命令がObjectDescriptionのサブクラスでない場合にAttributeErrorが開始される.
バージョン2.1.2(2019年6月19日リリース)¶
誤りを修正する¶
#6497:カスタム解析器は、文法が間違っている場合には強調できません
#6478、#6488:情報フィールドリスト識別エラー
バージョン2.1.0(2019年6月2日リリース)¶
互換性のない変更¶
ファイル拡張子が指定されていないファイル名を無視する
Builder.build_specific()
APIインタフェースを直接使用する#6230:タームリスト命令内のタームが非ASCII文字から構成されている場合、そのアンカーポイントを変更する
#4550:HTML:デフォルトでCSSを使用してフォームを中心にします。
#6239:LaTeX:中国語ドキュメントは、xelatexおよびxeCJKをデフォルトで使用します。
Sphinx.add_lexer()
今はInstanceではなくLexerクラスを受け入れます。Sphinx-3.xの前には,形態素解析器の用例がサポートされている
捨てて使う.¶
sphinx.builders.latex.LaTeXBuilder.apply_transforms()
sphinx.builders._epub_base.EpubBuilder.esc()
sphinx.directives.Acks
sphinx.directives.Author
sphinx.directives.Centered
sphinx.directives.Class
sphinx.directives.CodeBlock
sphinx.directives.Figure
sphinx.directives.HList
sphinx.directives.Highlight
sphinx.directives.Include
sphinx.directives.Index
sphinx.directives.LiteralInclude
sphinx.directives.Meta
sphinx.directives.Only
sphinx.directives.SeeAlso
sphinx.directives.TabularColumns
sphinx.directives.TocTree
sphinx.directives.VersionChange
sphinx.domains.python.PyClassmember
sphinx.domains.python.PyModulelevel
sphinx.domains.std.StandardDomain._resolve_citation_xref()
sphinx.domains.std.StandardDomain.note_citations()
sphinx.domains.std.StandardDomain.note_citation_refs()
sphinx.domains.std.StandardDomain.note_labels()
sphinx.environment.NoUri
sphinx.ext.apidoc.format_directive()
sphinx.ext.apidoc.format_heading()
sphinx.ext.apidoc.makename()
sphinx.ext.autodoc.importer.MockFinder
sphinx.ext.autodoc.importer.MockLoader
sphinx.ext.autodoc.importer.mock()
sphinx.ext.autosummary.autolink_role()
sphinx.ext.imgmath.DOC_BODY
sphinx.ext.imgmath.DOC_BODY_PREVIEW
sphinx.ext.imgmath.DOC_HEAD
sphinx.transforms.CitationReferences
sphinx.transforms.SmartQuotesSkipper
sphinx.util.docfields.DocFieldTransformer.preprocess_fieldtypes()
sphinx.util.node.find_source_node()
sphinx.util.i18n.find_catalog()
sphinx.util.i18n.find_catalog_files()
sphinx.util.i18n.find_catalog_source_files()
詳細については、ご参照ください deprecation APIs list それがそうです。
追加された機能¶
ヘルプ類の追加
sphinx.transforms.post_transforms.SphinxPostTransform
ブースターの追加方法
PythonDomain.note_module()
PythonDomain.note_object()
SphinxDirective.set_source_info()
#6180:サポート
--keep-going
BuildDoc Setupコマンドの使用math
指令は今支持しています:class:
選択権.処理待ち事項:
todo
指令は今支持しています:name:
選択権.以下の環境でオーバーレイを有効にする
SPHINXOPTS
そしてSPHINXBUILD
Makefile変数(参考文献:#6232,#6303)#6287:autodoc:モジュール関数として導出されたバインディングインスタンスメソッドを記録することができません。
#6289:autodoc:
autodoc_default_options
今応援していますimported-members
選択権.#4777:autodoc:サポートプロトコル
#744:autodoc:抽象化メソッドをサポート
#6325:autodoc:サポート中のプロパティ __slots__. 辞書上の様式 __slots__, Autodoc値を属性とする文書文字列
#6361:autodoc:追加
autodoc_typehints
署名中のタイプ提示を隠蔽するには,以下の操作を実行してください.#1063:autodoc:
automodule
命令は現在未記録のモジュールレベル変数を処理することができる.#6212自動要約:追加
autosummary_imported_members
自動集計に導入されたメンバーを表示するには、以下の操作を実行してください#6271:
make clean
もし‘’に建てられたら、悲劇的な破壊を受けるだろう。#6363:サポート
%O%
Make.batにおける環境変数#4777:PYドメイン名:追加
:async:
選択権.py:function
指令PYドメイン:新しいオプションを追加
py:method
指令:abstractmethod:
:async:
:classmethod:
:property:
:staticmethod:
RSTドメイン:追加
directive:option
OPTION FOR命令を記述するための命令#6306:HTML:アクセスを容易にするために検索フォームにタグを追加します。
#4390:HTML:一貫性、意味的署名CSS
#6358:
rawsource
財産production
ノードは現在完全なプロダクションルールを含む.#6373:autosetionLabel:警告を隠すことを可能にする
カバー範囲:新しいものをサポート
coverage_ignore_pyobjects
選択権.#6239:LaTeX:中国語ドキュメントの構築をサポート
誤りを修正する¶
#6230:タームが非ASCII文字から構成されている場合、タームリスト命令は、正しくないnode_idを生成する。
#6213:ifconfig:タイトル後のコンテンツは表示されません。
語彙表命令中の注釈タームは誤認識された
#6299:rstフィールド:rst:命令命令生成の無駄な空間
#6379:py domain:モジュールインデックス(py-modindex.html)タイトルの重複
#6331:MAN:タイトルの後のdoctestの出力が無効
#6351:参照されても、“Hyperlink target is not reference”(ハイパーリンク先が参照されていない)メッセージが表示されます。
#6165:autodoc:
tab_width
Docutilsの設定を無視しています#6347:autoc:Python 3.6および3.5で純粋なTupleを使用して崩壊
#6311:自動集計:自動集計テーブルは、複雑なタイプのプロンプトによって混同されています。
#6350:自動要約:あるデフォルト値を持つパラメータで混乱してしまいました。
生成されたMakefileは最終EOLを欠いている(参照:#6232)
#6375:extlink:リンクタイトルの括弧を変更できない
#6378:リンクチェック:一般的なユーザエージェントの送信
#6387:HTML検索:話し言葉やスクロールトピック付き文書の検索ができません
#6408:HTML検索:修復検索結果のランキング
#6406:戻る年のエラー
SOURCE_DATE_EPOCH
#6402:未知の画像フォーマットで画像指示が崩れた
#6286:C++であり、8および9を16進数の整数文字で表すことができます。
#6305:パーサ‘path’パラメータを修復するクイックスタートの文字列
LaTeX:警告中の数字にエラーが発生します(参考文献:#6364)
バージョン2.0.1(2019年4月8日リリース)¶
誤りを修正する¶
LaTeX:いくつかのシステムラベル未翻訳
RemovedInSphine 30警告は保留と表示されています
廃棄警告は出さない
sphinx.application.CONFIG_FILENAME
sphinx.builders.htmlhelp
viewcode_import
#6208:C++、短い外部参照をプレフィックスとする完全外部参照を正確に解析する
#6220,#6225:Napoleon:AttributeError参照を有する凸部誘発
#6245:SerializingHTMLBuilderの導入時にループインポートエラーが発生しました。
#6243:LaTeX_ELEMENTSのLaTeXを無視する:‘release asename’設定
#6244:HTML:サード·パーティ·トピックにより検索機能が中断されます。
#6263:HTML:HTML 5 Translatorがクラッシュし、フィールドノードが無効になります。
#6262:HTMLトピック:bizstyleトピックでフィールドリストのスタイルが変化しました。
バージョン2.0.0(2019年3月29日リリース)¶
依存性.¶
2.0.0b1
ラテックス製造業者は現在Tex Live 2015以上に依存している。
LaTeX生成器(ベルト
'pdflatex'
latex_engine
)のUnicodeギリシャ文字は、テキストフォントによって(数学表記形式ではなく)テキストフォントによって処理され、数学的表記に変換されない。関係をご参照ください'fontenc'
のキーワードです。latex_elements
ギリシャ語への支持が増えました例えばUbuntu Xenialではtexlive-lang-greek
および(デフォルトフォント設定が修正されていない場合)cm-super(-minimal)
ライオンの顔像ラテックスとして追加的に要求されます。ラテックス助剤付きラテックス助剤
latex_engine
とする.'xelatex'
あるいは送信することができます'lualatex'
(デフォルトの場合)必要FreeFont
フォントは、Ubuntu XenialでPackageによって提供されます。fonts-freefont-otf
また、例えばFedora 29にカプセル化することによりtexlive-gnu-freefont
それがそうです。バージョン2.5.0以上の要求
6つのパッケージはもはや係り受け関係ではありません
Sphinxcontrib-websupportパッケージはもはや依存しない
いくつかのパッケージは複数のサブパッケージに分割されています
sphinxcontrib.applehelp
sphinxcontrib.devhelp
sphinxcontrib.htmlhelp
sphinxcontrib.jsmath
sphinxcontrib.serializinghtml
sphinxcontrib.qthelp
互換性のない変更¶
2.0.0b1
Python 2.7および3.4へのサポートのキャンセル
Docutilsの削除0.11サポート
1.7.xで推奨されていない機能やAPIの削除
のデフォルト設定
master_doc
更に変更する.'index'
これは長い間、ライオンの顔像-クイック入門のデフォルト設定として使用されてきた。LaTeX:メッセージリソースを
sphinxmessage.sty
LaTeX:使用停止
\captions<lang>
あるラベルのマクロLaTeX:
'xelatex'
そして'lualatex'
使用、使用FreeFont
OpenTypeフォントのデフォルト選択(参照:#5645)ラテックス:
'xelatex'
そして'lualatex'
今使っています\small
コードブロックでは(なぜならFreeMono
文字幅)好き'pdflatex'
もうそうしましたCourier
文字幅)。あなたは通過する必要があるかもしれませんlatex_elements
'fvset'
キーは,他のOpenTypeフォントを用いた場合(参照番号:#5768)LaTeX:テキスト中のギリシャ文字は、数学フォントではなくテキストフォントを使用する数学パターンタグに変換されません。♪the
LGR
フォントコードを追加しなければなりません'fontenc'
のキーワードです。latex_elements
それを機能させるために(もちろん、文書が必要な場合にのみ)。LaTeX:設定
language
至る'en'
トリガー式.Sonny
オプションfncychap
今はそうですBjarne
未指定言語の大文字にマッチする.(参考文献:#5772)#5770:doctest:注目
highlight_language
ハイライトはdoctestブロックを示します。したがって、デフォルトの場合、それらはpython 3として強調表示されます。The order of argument for
HTMLTranslator
,HTML5Translator
andManualPageTranslator
are changedLaTeX:ハードコードの再定義
\l@section
そして\l@subsection
以前は入れていた'manual'
Docclassは後で実行します\sphinxtableofcontents
それがそうです。これは,LaTeXプリアンブル中のカスタムユーザ定義が現在上書きされていることを意味する.使用\sphinxtableofcontentshook
カスタムユーザ定義を挿入するには,以下の操作を実行してください.見 宏 それがそうです。クイックスタート:生成を簡略化する
conf.py
#4148:クイックスタート:いくつかの質問が削除されました。彼らはコマンドラインオプションで指定することができます
WebSupport:ライオンの顔像コアから分離する.Sphinxcontrib-websupportをご利用ください
C++,基底クラスの可視性は現在つねに入力に現れている.つまり、
private
これは以前にポップアップされた場所を示していますLaTeX:幅および/または高さオプションを使用しても、大きな画像を含む図形は、テキストの幅および高さを超えないように再スケーリングされます。(参考文献:#5956)
EPub:
epub_title
デフォルト設定はproject
選択権.#4550:すべてのテーブルおよび図面がありません。
align
オプションは中心位置に表示されます。#4587:HTML:HTML 5のデフォルト出力
2.0.0b2
Texinfo:画像ファイルをコピーする
name-figure
カタログ.
捨てて使う.¶
2.0.0b1
Python 2文法の値を求めるサポートを使用することはお勧めしません。これには、Python 3に変換すべきプロファイルが含まれています。
The arguments of
EpubBuilder.build_mimetype()
,EpubBuilder.build_container()
,EpubBuilder.bulid_content()
,EpubBuilder.build_toc()
andEpubBuilder.build_epub()
の論拠
Epub3Builder.build_navigation_doc()
構成変数
The
encoding
argument ofautodoc.Documenter.get_doc()
,autodoc.DocstringSignatureMixin.get_doc()
,autodoc.DocstringSignatureMixin._find_signature()
, andautodoc.ClassDocumenter.get_doc()
are deprecated.♪the
importer
論争する.sphinx.ext.autodoc.importer._MockModule
♪the
nodetype
論争する.sphinx.search.WordCollector. is_meta_keywords()
♪the
suffix
論争する.env.doc2path()
賛成しません。文字列スタイル
base
論争する.env.doc2path()
賛成しません。省略を許す
filename
パラメータは書き換えられたものからIndexBuilder.feed()
方法は既に廃棄された.sphinx.addnodes.abbreviation
sphinx.application.Sphinx._setting_up_extension
sphinx.builders.epub3.Epub3Builder.validate_config_value()
sphinx.builders.html.SingleFileHTMLBuilder
sphinx.builders.htmlhelp.HTMLHelpBuilder.open_file()
sphinx.cmd.quickstart.term_decode()
sphinx.cmd.quickstart.TERM_ENCODING
sphinx.config.check_unicode()
sphinx.config.string_classes
sphinx.domains.cpp.DefinitionError.description
sphinx.domains.cpp.NoOldIdError.description
sphinx.domains.cpp.UnsupportedMultiCharacterCharLiteral.decoded
sphinx.ext.autodoc.importer._MockImporter
sphinx.ext.autosummary.Autosummary.warn()
sphinx.ext.autosummary.Autosummary.genopt
sphinx.ext.autosummary.Autosummary.warnings
sphinx.ext.autosummary.Autosummary.result
sphinx.ext.doctest.doctest_encode()
sphinx.io.SphinxBaseFileInput
sphinx.io.SphinxFileInput.supported
sphinx.io.SphinxRSTFileInput
sphinx.registry.SphinxComponentRegistry.add_source_input()
sphinx.roles.abbr_role()
sphinx.roles.emph_literal_role()
sphinx.roles.menusel_role()
sphinx.roles.index_role()
sphinx.roles.indexmarkup_role()
sphinx.testing.util.remove_unicode_literal()
sphinx.util.attrdict
sphinx.util.force_decode()
sphinx.util.get_matching_docs()
sphinx.util.inspect.Parameter
sphinx.util.jsonimpl
sphinx.util.osutil.EEXIST
sphinx.util.osutil.EINVAL
sphinx.util.osutil.ENOENT
sphinx.util.osutil.EPIPE
sphinx.util.osutil.walk()
sphinx.util.PeekableIterator
sphinx.util.pycompat.NoneType
sphinx.util.pycompat.TextIOWrapper
sphinx.util.pycompat.UnicodeMixin
sphinx.util.pycompat.htmlescape
sphinx.util.pycompat.indent
sphinx.util.pycompat.sys_encoding
sphinx.util.pycompat.terminal_safe()
sphinx.util.pycompat.u
sphinx.writers.latex.ExtBabel
sphinx.writers.latex.LaTeXTranslator._make_visit_admonition()
sphinx.writers.latex.LaTeXTranslator.babel_defmacro()
sphinx.writers.latex.LaTeXTranslator.collect_footnotes()
sphinx.writers.latex.LaTeXTranslator.generate_numfig_format()
sphinx.writers.texinfo.TexinfoTranslator._make_visit_admonition()
sphinx.writers.text.TextTranslator._make_depart_admonition()
LaTeXテンプレートのテンプレート変数
logo
numfig_format
pageautorefname
translatablestrings
詳細については、ご参照ください deprecation APIs list それがそうです。
追加された機能¶
2.0.0b1
#1618:生成されたHTML文書の検索結果プレビューは、読者により友好的である:Sphinxは、コード片を元のreStruredTextタグとして表示するのではなく、対応するHTMLを提示する。これはSphinx拡張を意味します `Sphinx: pretty search results`_ _はもう必要ありません。カスタムや第三者HTMLテンプレートの検索機能を変更することで、この改善がカバーされる可能性があることに注意されたい。
#4182:autodoc:サポート
suppress_warnings
#5533:autodoc:
autodoc_default_options
支持台.member-order
#5394:autodoc:アナログオブジェクトのタイプの書き込みに読み取り可能な名前を表示する
#5459:autodoc:
autodoc_default_options
受け入れるTrue
一つの価値として#1148:autodoc:追加
autodecorator
内装担当者への指示#5635:自動要約:追加
autosummary_mock_imports
導入目標上の外部ライブラリのシミュレーション#4018:htmlhelp:追加
htmlhelp_file_suffix
そしてhtmlhelp_link_suffix
#5559:text:複合テーブル(colspanおよびrowspan)をサポート
LaTeX:非シリル文書でギリシャとシリルUnicode文字を提示することをサポートしています(現在は数学ではありません)、使用しても
'pdflatex'
としてlatex_engine
(参考文献:#5645)#5660: The
versionadded
,versionchanged
anddeprecated
directives are now generated with their own specific CSS classes (added
,changed
anddeprecated
, respectively) in addition to the genericversionmodified
class.#5841:apidoc:sphinx-apidocに追加--拡張オプション
#4981:C++は、既存の宣言(例えば、概要を作成する)を参照する宣言リストを挿入するためのエイリアス命令を追加します。
C++:追加
cpp:struct
補充することができますcpp:class
それがそうです。#1341 HTML検索長さ3以上の検索語を含む単語を一致とします。
#4611:ePub:重複ディレクトリエントリを表示する警告
#1851:省略を許可
code-block
指令する。省略すると,以下のようになるhighlight
あるいは…。highlight_language
#4587:HTML:追加
html4_writer
古いHTML 4コンパイラを使って#6016:HTML検索:検索要約の占位子は、検索結果リンクが検索終了時にその位置を変更することを防止することができます。これにより,ナビゲーション検索結果が容易になる.
#5196:LinkCheckリモート·イメージの有無も確認
#5924:githubages:以下の場合、カスタムドメインのCNAMEファイルを作成する
html_baseurl
集#4261:autosetionLabel:新しい構成値によってラベルセグメントを制限します。
autosectionlabel_maxdepth
誤りを修正する¶
2.0.0b1
#1682:LaTeX:コンパイラはギリシャUnicodeを翻訳するのではなく、textgreekパッケージを使用する必要があります。
#5247:LaTeX:PDFはロシア語と
'xelatex'
あるいは…。'lualatex'
としてlatex_engine
(参考文献:#5251)#5248:LaTeX:部分タイトルのギリシャ文字がPDFブックマークから消えます
#5249:LaTeX:数学コマンドのUnicodeギリシャ文字Break PDF Build(修復には追加設定が必要ですので、参照
latex_elements
'textgreek'
鍵および/またはlatex_engine
設定)#5772:LaTeX:言語オプションとして通過する場合、bjarne風のfncychapも英語に使用すべきですか?
#5179:LaTeX:(Lualatexのみ)変換
>
vt.から.\textgreater{{}}
十分ではありませんなぜなら\textgreater{{}}\textgreater{{}}
タークス結紮法を適用するLaTeX:以下の条件を満たせば,項目名は変換されない.
latex_documents
省略する.LaTeX:以下の条件を満たしていれば,著者を表示しない.
latex_documents
省略する.HTML:複数のタームを持つ語彙表を記述する無効なHTML 5ファイルを生成する(参照:#4611参照).
QtHelp:.qhpファイルにはオペレーティングシステムに関するパスセパレータが使用されている.
HTML検索:複数の検索語を用いて1つの検索語が3文字より短い場合,検索はつねに何も返さない.
2.0.0b2
#6096:HTML:アンカーリンクを追加しないイラスト
#3620:HTML:AJAXによるロードではなく、searchindex.jsを遅らせる
#6113:HTML:フォームセルとリストエントリのページエッジ距離が大きい
#5508:
linenothreshold
オプション:highlight
指令が無視されるテキスト情報:
make install-info
文法の誤りを招くテキスト情報:
make install-info
MacOSで失敗しました#3079:texinfo:イメージファイルのコピーなし
make install-info
#5391:タイトルのクロスリファレンスがテキストとして提示されます。
#5946:C++、修復
cpp:alias
LaTeX(およびsinglehtml)における問題#6147:のクラス属性
citation_reference
ノードが失われるカスタマイズ時にAssertionErrorを引き起こす
citation_reference
CLASSES属性を持つノード引用欠損引用文(参考文献:#6147)#2155:サポート
code
指令C++は,括弧付き初期値設定項の解析を修復した.
#6172:古いスタイルのインデックスノードへのAttributeErrorの開始
#4872:継承関係マップ:正しい説明
parts
選択肢は,負の値を許す.#6178:I 18 N:隠れディレクトリの翻訳に字幕が欠落している
バージョン2.0.0最終版
#6196:Pyドメイン:予期しないプレフィックスの生成
テストをする¶
2.0.0b1
使用を中止する.
SPHINX_TEST_TEMPDIR
環境変数
2.0.0b2
追加補助関数:
sphinx.testing.restructuredtext.parse()
バージョン1.8.5(2019年3月10日リリース)¶
誤りを修正する¶
LaTeX:PDFバナーページの著者名を削除した不要なスペース(参考文献:#6004)
#6026:LaTeX:クロスリファレンス定義リストは機能しません
#6046:LaTeX:
TypeError
無効なLaTeX_ELEMENTSが与えられたときに開始される#6067:LaTeX:次の行にターゲット画像が接続されている
#6067:LaTeX:ターゲットを持つ画像は指定されても整列しません
#6149:ラテックス:
:index:
職名原因の役割Use of \@icentercr doesn't match its definition
Latexpdf生成時エラー#6019:imgConverter:PDFを複数ページ含む失敗
#6047:autodoc:
autofunction
メソッドオブジェクトに警告を発する#6028:raphviz:raphvizファイル名が再生可能であることを確認します。
#6068:doctest:
skipif
オプションは文書からコードブロックを削除する場合があります#6136:
:name:
オプション:math
指令が崩壊を招く#6139:intersphinx:失敗レポートのValueError
#6135:変更:任意のモジュールが見つかったときにUnbound LocalErrorを修復します。
#3859:マニュアルページ:コードブロックタイトル表示が正しくない
バージョン1.8.4(2019年2月3日リリース)¶
誤りを修正する¶
#3707:LaTeX:太字再選択フラグ(゚)がありません。
#5605:文書言語が中国語に設定されている場合、英単語を検索できません。
#5889:LaTeX:ユーザ
numfig_format
空間を奪われると、生成に失敗する可能性がありますC++,EAST cv限定子に関する宣言のハイパーリンクを修復する.
#5755:C++、戻るタイプの制約を有する関数テンプレート上の重複宣言エラーを修復します。
C++は,1元右折り畳み式とバイナリ折り畳み式を解析する.
PycodeはWindows上で卵ファイルを処理することができません
#5928:Buildを実行したときのKeyError:‘DOCUTILSCONFIG’
#5936:LaTeX:ページの高さより高い画像が警告に含まれているため、PDFバージョンは中断されます。
#5231:“make html”locale“ディレクトリの”po“ファイルを読み込み、構築しません。
#5954:
:scale:
画像オプションはPDF Build If警告の画像を中断する可能性があります#5966:インクリメンタル生成時にMathjaxがロードされていません。
#5960:LaTeX:2018年9月のTeXLive更新以来PDFレイアウトの変更
parskip.sty
#5948:LaTeX:小節の重複ラベルの生成
#5958:VersionAddedコマンドによりPython 3.5.0が崩壊します。
#5995:autoc:autoc_mock_ImportsとPython 3.7のメタクラスとの競合
#5871:texinfo:A部分タイトル
.
許されません。
バージョン1.8.3(2018年12月26日リリース)¶
追加された機能¶
LaTeX: it is possible to insert custom material to appear on back of title page, see discussion of
'maketitle'
key oflatex_elements
('manual'
docclass only)
誤りを修正する¶
#5725:mathjax:最新バージョンのデフォルトでCDNアドレスを使用する
#5460:HTML検索は、サードパーティ·トピックのいくつかには適用されません。
#5520:Sphinx 1.6からLaTeX、字幕パッケージは互換性がありません
#5614:autodoc:内蔵モジュールの導入時のインクリメンタル構築中断
#5627:QtHelpにqthelp:index.htmlが欠落しています。
#5659:Linkcheck:マルチバイト文字を含むハイパーリンクが崩れます。
#5754:DOC:修復中のエラーのいくつか ラテックスカスタマイズ
#5810:LaTeX:sphinxVerbatim 1.6.6から明示的な“hlline”設定が必要です(参照:#1238参照)
#5636:C++、浮動小数点文字の解析が修復されました。
#5496(再度):C++、重複項を有する部分構築におけるアサートを修復します。
#5724:$LC_ALLが空き時間QuickStart:Sphinx-QuickStart失敗
#1956:デフォルトのconf.pyはPEG 8に準拠していません
#5849:LaTeX:ドキュメントクラス
\maketitle
カバーされていて、Sphinxのカスタム意味の代わりに原始的な意味を使うことはできません#5834:apidoc:エラーのヘルプ
--tocfile
#5800:TODO:TextElementにTODOが定義されていれば崩壊
#5846:htmlhelp:.hhc/.hhkファイルで16進数変換を10進変換に変換します。
Htmlhelp:タイトルが二重引用符を含む場合に生成された破損.hhkファイル
バージョン1.8.2(2018年11月11日リリース)¶
互換性のない変更¶
#5497:確かに必要でない限り、MathJax.jsおよびjsmather.jsは含まれていません。
追加された機能¶
#5471:適切な廃棄警告の表示
誤りを修正する¶
#5490:LaTeX:エニュメレーション·リストによるRECONOMARKの崩壊
#5492:Sphinx-Buildは、3.5.2未満のPython構築ドキュメントを使用できません。
#3704:LaTeX:エラー
\label
図例付きイラストの位置づけ#5496:C++、1つのシンボル宣言が2回以上宣言された場合のアサートを修復します。
#5493:gettext:テンプレートの破損により崩壊します。
#5495:ファイル·オプションを含むCSV-TABLEコマンドの中断(参照:#4821)
#5498:autodoc:見つからない
functools.partial
#5480:autodoc:解析できない順方向参照のタイプ提示が見つからない
#5419:互換性のないMATH_BLOCKノードが生成されました
#5548:ファイルがすでに存在する場合、ensuredir()を修復します。
#5549:Graphvizが存在しない静的ディレクトリを正しく処理する
#3002:I 18 N:同じ脚注を参照する複数のFootnote_Referencesは、重複node_idをもたらす
#5563:拡張によって生成されたLaTeX:Footnote_ReferencesによるLaTeX構築器の崩壊
#5561:古いxindyバージョンのmake all-pdfは失敗しました。
#5557:QuickStart:--バッチ処理ファイルはサポートされていません
#3080:texinfo:複数行のrubricsが破損しています。
#3080:texinfo:複数行参照中断
バージョン1.8.1(2018年9月22日リリース)¶
互換性のない変更¶
ラテックス
\pagestyle
コマンドはLaTeXテンプレートに移動しました。以下のような場合がない限り、PDFには何の変更もありません。\sphinxtableofcontents
その中にはそれらが含まれていますconf.py
それがそうです。(参考文献:#5455)
誤りを修正する¶
#5418:sphinx-build-d/doctreeファイルのデフォルトパスが正しくない
#5421:Autodocは、以下の項目を破棄する警告を発行します。
autodoc_default_flags
#5422:Lambdaオブジェクトのストレージ環境でのPicklingErrorの結果
#5417:Python 2.7.5のSphinx構築に失敗し、構文エラーが発生しました。
#4911:makeモードではないmake.batにlatexpdfを追加します。
#5436:Autodocは、属性/メソッドを持つ枚挙サブクラスには適用されません。
#5437:autodoc:卵を導入したモジュールでクラッシュする
#5433:LaTeX:ImportError:名前‘DEFAULT_SETTINGS’をインポートできません。
#5431:autodoc:
autofunction
呼び出し可能なオブジェクトに警告する#5457:オーバーレイ禁止時のエラーメッセージのTypeErrorの修復
#5453:“HOWTO”ドキュメントのPDFバージョンにはページ番号がありません
#5463:Mathbase:MATH_ROLEおよびMathDirectiveは1.8.0で消失
#5454:日本語文書の場合、LaTeX:PDFからインデックスが消失しました
#5432:PYドメイン名:
:type:
フィールドは処理できない:term:
参考文献#5426:クラス属性がPyドメインを誘発した:TypeError
バージョン1.8.0(2018年9月13日リリース)¶
依存性.¶
1.8.0b1
ラテックス:
latex_use_xindy
もし、もしTrue
(黙考)xelatex/lualatex
)、指示make latexpdf
使用 xindy 一般指数に使われていますあなたのLaTeX配布にそれが含まれていることを確実にしてください。(参考文献:#5134)ラテックス:
latexmk
必要なのですmake latexpdf
Windowsについては
互換性のない変更¶
1.8.0b2
#5282:HTMLトピック:参照
pygments_style
HTMLトピックを優先的に設定するダウンロードファイルのURLを変更する
#5127:クイックスタート:
Makefile
そしてmake.bat
存在すればカバーされない
1.8.0b1
#5156: :py:mod:`sphinx.ext.graphviz: extension runs ` 構築する文書ディレクトリ中のdot`は,文書のルートディレクトリ中のdot`ではない.
#4460:環境に格納された任意のデータを拡張するには、その環境データ構造のバージョンをメタデータとして返す必要があります。具体的には見てください メタデータを拡張する それがそうです。
Sphinx所望のソースコード解析器モジュールは,以下のようにサポートされるファイルフォーマットを持つ.
Parser.supported
属性デフォルト値です。
epub_author
そしてepub_publisher
従'unknown'
の価値author
それがそうです。これはconf.py
ファイルsphinx-buildを生成する.♪the
gettext_compact
属性はすでに従したdocument.settings
物体です。どうぞconfig.gettext_compact
代わりに。読み出しフェーズの処理手順を変更する.SMART_QUOTES、ライオンの顔画像ドメイン名
doctree-read
イベントおよびバージョン制御文書木は、現在よりも早く呼び出される。詳細については、お読みくださいSphinx.add_transform()
#4827:全て
substitution_definition
ノードは読み込み段階でdoctreeから削除される.docutils.conf
はい。$HOME
あるいは…。/etc
リストは無視されるだろう。わずかdocutils.conf
コンディールから来たのは服従しています。#789:
:samp:
逆スラッシュで大括弧を回転させるキャラクターサポート#4811:次のファイル
html_static_path
ソースファイルから除外します。LaTeX:使用
\sphinxcite
参考に供する.\hyperref
配置値
viewcode_import
改名しました。viewcode_follow_imported_members
(参考文献:#4035)#1857:ラテックス:
latex_show_pagerefs
引用を加えないヘッダ#4648:LaTeX:現在の“Qubric”要素は、番号付けされていない部分タイトルになっています。
#4983:HTML:ProductionListトークンのアンカが変更されました。
テンプレート変数の修正
script_files
現在テンプレートでの使用が許可されています。どうぞapp.add_js_file()
代わりに。#5072:環境オブジェクトは、新しいドキュメントのみで保存されます。
#5035:qthelp生成器許可
qthelp_namespace
LaTeX:デフォルトではlualatexまたはxelatexを使用 xindy UTF-8として代替できるのは makeindex (参考文献:#5134)Sphinxがアップグレードした後、新築前に既存プロジェクトのラテックス構築庫を整理してください。
#5163:html:hlistプロジェクトは、トップと整列しています。
highlightlang
指令は解析段階で処理する#4000:LaTeX:テンプレートが変更されました。以下の要素は移動されている:
\begin{document}
shorthandoff
変数.変数maketitle
変数.変数tableofcontents
変数.変数
捨てて使う.¶
1.8.0b2
sphinx.io.SphinxI18nReader.set_lineno_for_reporter()
すでに使用を放棄した.sphinx.io.SphinxI18nReader.line
すでに使用を放棄した.sphinx.util.i18n.find_catalog_source_file()
変わっています gettext_compact パラメータはすでに廃棄された.#5403:
sphinx.util.images.guess_mimetype()
変わっています 内容 パラメータはすでに廃棄された.
1.8.0b1
source_parsers
すでに使用を放棄した.autodoc_default_flags
すでに使用を放棄した.クイックスタート:
--epub
オプションはデフォルト値になりますので、オプションの使用はお勧めしません関数ベースの命令サポートは破棄される。現在、Sphinxはクラスベースの命令のみをサポートしています(参照
Directive
)sphinx.util.docutils.directive_helper()
すでに使用を放棄した.sphinx.cmdline
すでに使用を放棄した.sphinx.make_mode
すでに使用を放棄した.sphinx.locale.l_()
すでに使用を放棄した.#2157:ヘルパー関数
warn()
FOR HTML Themesのご利用はお勧めしておりませんapp.override_domain()
すでに使用を放棄した.app.add_stylesheet()
すでに使用を放棄した.app.add_javascript()
すでに使用を放棄した.app.import_object()
すでに使用を放棄した.app.add_source_parser()
変わっています 接尾辞 パラメータはすでに廃棄された.sphinx.versioning.prepare()
すでに使用を放棄した.Config.__init__()
has changed; the dirname, filename and tags argument has been deprecatedConfig.check_types()
すでに使用を放棄した.Config.check_unicode()
すでに使用を放棄した.sphinx.application.CONFIG_FILENAME
すでに使用を放棄した.highlightlang
指令はすでに廃棄された.BuildEnvironment.load()
すでに使用を放棄した.BuildEnvironment.loads()
すでに使用を放棄した.BuildEnvironment.frompickle()
すでに使用を放棄した.env.read_doc()
すでに使用を放棄した.env.update()
すでに使用を放棄した.env._read_serial()
すでに使用を放棄した.env._read_parallel()
すでに使用を放棄した.env.write_doctree()
すでに使用を放棄した.env._nitpick_ignore
すでに使用を放棄した.env.versionchanges
すでに使用を放棄した.env.dump()
すでに使用を放棄した.env.dumps()
すでに使用を放棄した.env.topickle()
すでに使用を放棄した.env.note_versionchange()
すでに使用を放棄した.sphinx.writers.latex.Table.caption_footnotetexts
すでに使用を放棄した.sphinx.writers.latex.Table.header_footnotetexts
すでに使用を放棄した.sphinx.writers.latex.LaTeXTranslator.footnotestack
すでに使用を放棄した.sphinx.writers.latex.LaTeXTranslator.in_container_literal_block
すでに使用を放棄した.sphinx.writers.latex.LaTeXTranslator.next_section_ids
すでに使用を放棄した.sphinx.writers.latex.LaTeXTranslator.next_hyperlink_ids
すでに使用を放棄した.sphinx.writers.latex.LaTeXTranslator.restrict_footnote()
すでに使用を放棄した.sphinx.writers.latex.LaTeXTranslator.unrestrict_footnote()
すでに使用を放棄した.sphinx.writers.latex.LaTeXTranslator.push_hyperlink_ids()
すでに使用を放棄した.sphinx.writers.latex.LaTeXTranslator.pop_hyperlink_ids()
すでに使用を放棄した.sphinx.writers.latex.LaTeXTranslator.check_latex_elements()
すでに使用を放棄した.sphinx.writers.latex.LaTeXTranslator.bibitems
すでに使用を放棄した.sphinx.writers.latex.LaTeXTranslator.hlsettingstack
すでに使用を放棄した.sphinx.writers.latex.ExtBabel.get_shorthandoff()
すでに使用を放棄した.sphinx.writers.html.HTMLTranslator.highlightlang
すでに使用を放棄した.sphinx.writers.html.HTMLTranslator.highlightlang_base
すでに使用を放棄した.sphinx.writers.html.HTMLTranslator.highlightlangopts
すでに使用を放棄した.sphinx.writers.html.HTMLTranslator.highlightlinenothreshold
すでに使用を放棄した.sphinx.writers.html5.HTMLTranslator.highlightlang
すでに使用を放棄した.sphinx.writers.html5.HTMLTranslator.highlightlang_base
すでに使用を放棄した.sphinx.writers.html5.HTMLTranslator.highlightlangopts
すでに使用を放棄した.sphinx.writers.html5.HTMLTranslator.highlightlinenothreshold
すでに使用を放棄した.sphinx.ext.mathbase
拡張はすでに廃棄された.sphinx.ext.mathbase.math
ノードはすでに廃棄された.sphinx.ext.mathbase.displaymath
ノードはすでに廃棄された.sphinx.ext.mathbase.eqref
ノードはすでに廃棄された.sphinx.ext.mathbase.is_in_section_title()
すでに使用を放棄した.sphinx.ext.mathbase.MathDomain
すでに使用を放棄した.sphinx.ext.mathbase.MathDirective
すでに使用を放棄した.sphinx.ext.mathbase.math_role
すでに使用を放棄した.sphinx.ext.mathbase.setup_math()
すでに使用を放棄した.sphinx.directives.other.VersionChanges
すでに使用を放棄した.sphinx.highlighting.PygmentsBridge.unhighlight()
すでに使用を放棄した.sphinx.ext.mathbase.get_node_equation_number()
すでに使用を放棄した.sphinx.ext.mathbase.wrap_displaymath()
すでに使用を放棄した.♪the
trim_doctest_flags
論争する.sphinx.highlighting.PygmentsBridge
すでに使用を放棄した.
詳細については、ご参照ください deprecation APIs list
追加された機能¶
1.8.0b2
#5388:凍結されたオブジェクト記述が再生可能であることを確認します。
#5362:apidoc:追加
--tocfile
ディレクトリ·ファイル名を変更するオプション
1.8.0b1
増列する.
config-inited
事件増列する.
sphinx.config.Any
配置値を表しており,任意のタイプの値を受け取ることができる.source_suffix
FILEXTのファイルタイプへのマッピングを可能にする増列する.
author
配置値として#2852:imgConverter:GIF形式のPNG形式への変換をサポート
sphinx-build
コマンドはI 18 Nコンソール出力をサポート増列する.
app.add_message_catalog()
そしてsphinx.locale.get_translations()
第三者内線の翻訳をサポートする扶助器関数
warning()
HTMLトピックに追加しました増列する.
Domain.enumerable_nodes
ドメインを管理する自己列挙可能ノード(実験)新しいキーワードパラメータの追加
override
アプリケーションAPIへLaTeX:新しい鍵
'fvset'
上のlatex_elements
それがそうです。XeLaTeX/LuaLaTeXのデフォルト設定fanvyvrb
コードブロックには、サイズではなく、通常のフォントサイズが使用されます(参照:#4793参照)増列する.
html_css_files
そしてepub_css_files
構成からCSSファイルを追加する増列する.
html_js_files
構成からJSファイルを追加するための#4834:設定されたオブジェクト記述が再生可能であることを確認します。
#4828:オーバーレイを許可
numfig_format
部分的には。完全な定義は必要ありません。改善中の警告メッセージ(参照:#4818参照)
LaTeX:個別にカスタマイズできます
guilabel
そしてmenuselection
(参考文献:#4830)増列する.
Config.read()
プロファイルから新しい構成オブジェクトを作成するクラス方法#4866:Graphvizグラフのパッケージ
<div>
標札.ビデオコード:追加
viewcode-find-source
そしてviewcode-follow-imported
ロードせずにソースコードをロードするには、以下の操作を実行してください#4785:ナポレオン:ネイティブ化のために翻訳文書に文字列を追加する
#4927:Highlightコマンドのlinenothresholdオプションに無効値を渡すと警告が表示されます。
C++:
1つ追加する
cpp:texpr
兄弟の役としてcpp:expr
それがそうです。労働組合への支持を増やす。
#3593、#2683:ペア名を追加します。
@
それがそうです。#5147:文字文字のサポートを追加します。
メインテンプレート内の交差参照エンティティをサポートし,現在正しく記録されている.
#1552:新しいクロスリファレンス形式の追加
cpp:any
そしてcpp:func
ロールは、特定の関数を参照して再ロードするために使用される。
#3606:MathJaxは非同期プロパティをロードする必要があります
HTML:出力
canonical_url
メタデータ(もしhtml_baseurl
SET(参考文献:#4193)#5029:自動集計:露出
inherited_members
テンプレートまで#3784:Mathjax:追加
mathjax_options
Mathjaxのスクリプトタグにオプションを提供#726,#969:Mathjax:Add
mathjax_config
Mathjaxのイントラネット構成を与えるには、以下の操作を実行してください#4362:LaTeX:ドキュメントが変更されていない場合、.texファイルを上書きしない
#1431:LaTeX:英数字列挙リストサポートの追加
増列する.
latex_use_xindy
UTF-8スマートインデックスについては、デフォルトではTrue
もしlatex_engine
はい。'xelatex'
あるいは…。'lualatex'
それがそうです。(参考文献:#5134,#5192,#5212)#4976:
SphinxLoggerAdapter.info()
今応援していますlocation
パラメータ#5122:setuptools:選り好みオプションをサポート
#2820:autoclassコマンドはネストクラスをサポート
増列する.
app.add_html_math_renderer()
HTMLに数学的レンダラーを登録する応用
trim_doctest_flags
すべての建築業者へ(参照)テキスト·マニュアルページ)#5140:LinkCheck:HTTPクライアントにより良いAcceptヘッダを追加する
#4614:ライオンのイメージ-内部バージョン:追加
--keep-going
すべての警告を表示するためのオプション増列する.
math:numref
引用式の役割(とeq
)クイックスタート:デフォルトでePubビルダを有効にする
#5246:追加
singlehtml_sidebars
Singlehtmlジェネレータにサイドバーを配置するには、以下の操作を実行してください#5273:doctest:doctestをスキップする条件がある
#5306:autodoc:無効タイプのプロンプトが発行されたことを警告します。
#4075,#5215:autodoc:追加
autodoc_default_options
Dictとしてオプション値を受け取ります
誤りを修正する¶
1.8.0b2
HTML:スクロールすると検索ボックスが他の要素をカバーします
I 18 N:翻訳リストの警告行番号エラー(参照:#5321)
#5325:LaTeX:クロスリファレンスは、複数のタグオブジェクトによって中断されています。
C++は、記号追加とルックアップを修復しました。探索はこれ以上部分生成で中断すべきではない.なお#5337を参照されたい。
#5348:リモートファイルのダウンロード参照が表示されていません
#5282:HTMLトピック:
pygments_style
テーマの内容が入れ替わるconf.py
黙認#4379:ドキュメントを除外した場合、toctreeは困惑した警告を表示します。
#2401:autodoc:
:members:
成因.:special-members:
展示されませんAutoDoc:より深いモジュールの場合、ImportErrorはAttributeErrorに置き換えられます。
#2720、#4034:誤ったリンク
:download:
.繰り返し名と並行構築#5290:autodoc:卵パックのソースコードを解析できません。
#5399:未知のpoファイルが存在する場合、Sphinxは崩壊します。
1.8.0b1
I 18 N:初期化のたびにメッセージディレクトリをリセットする.
#4850:LaTeX:脚注内の脚注は提示されていない
#4945:I 18 N:IndexBuilderのLANG_COUNTRYを正しくフォールバックしません。朱勝景に感謝します。
#4983:ProductionListコマンドは、トークンに対して無効なIDを生成する
#5132:lualatex:インデックスのWordがUnicode文字で始まる場合、PDF構築に失敗します。
#5133:LaTeX:インデックスタイトル“記号”および“数字”は国際化されていない
#5114:Sphinx-Build:文書をスキャンする際のエラー
EPub:リストツリーに“self”を並べたときに脊椎が切断されています(参照:#4611参照)
#344:モジュールレベルの属性を理解していない文書文字列を自動的にまとめる
#5191:C++であり、問題の発見を回避するために関数内の入れ子宣言を回避します。
#5126:C++、いくつかのテンプレート·パラメータ·タイプに欠落したisPackメソッドを追加します。
#5187:C++であり、宣言子上の属性を解析することもできます。
C++,DELETE式と基本的な新しい式を解析する.
#5002:raphviz:SVGは列幅に適応していません。
バージョン1.7.9(2018年9月5日リリース)¶
追加された機能¶
#5359:アンカをソートすることによって、生成されたtexinfoファイルを再生することができます。
誤りを修正する¶
#5361:ドキュメントがINCLUDE命令を使用している場合、インクリメンタル生成時にクラッシュします。
バージョン1.7.8(2018年8月29日リリース)¶
互換性のない変更¶
タイプ
env.included
DICT OF SETに変更されました
誤りを修正する¶
#5320:intersphinx:提供されたurlが無効である場合、クラッシュ
#5326:マニュアルページ:無効文書名を経時的にクラッシュとして指定する
man_pages
#5322:autodoc:
Any
タイプ提示によるフォーマットエラー#5327:生成されたファイルを使用して再生成された場合に“Document is not included in any toctree”警告が表示されます。
#5335:クイックスタート:変換シーケンスはMacPortsのpythonで表示されました。
バージョン1.7.7(2018年8月19日リリース)¶
誤りを修正する¶
#5198:並列に生成されたファイルのみが含まれている場合,文書がToctreeにない警告
LaTeXコンソール出力のLaTeX:Reduce“Token Not Allowed in a PDF String”Hyperref警告(参照:#5236参照)
LaTeX:最新のLaTeXを使用して、LaTeXコンソール出力に“再リセット警告:再リセットパッケージは時代遅れ”を表示することを禁止します(参照:#5237参照)
#5234:PDF出力:Sphinx 1.5から紙環境変数の使用を中断しました
LaTeX:修復
latex_engine
XeLaTeX/LuaLateXを用いたラテン語現代フォントに関する文書(参照:#5251参照)#5280:autodoc:複雑なタイプのエラー·タイプの書き込みを修復する
Autodoc:オプションのタイプにエラーが表示されます。
#5291:Autodoc ForwardRefタイプでクラッシュ
#5211:autodoc:関数ツールのための文書が生成されていません。部分関数
#5306:autodoc:
getargspec()
無効パターン提示を引き起こすNameError#5298:imgath:MATH_NUMBER_ALLにより、htmlに2つの数字があります。
#5294:Sphinx-PowerShellのクイックスタートの空白のヒント
バージョン1.7.6(2018年7月17日リリース)¶
誤りを修正する¶
#5037:ラテックス
\sphinxupquote{{}}
ロシア語の中断Sphinx.testは、古いpytest APIを使用する。
Node.get_marker(name)
#5016:推奨フラグを有効にするとクラッシュします。AutoStrictifyを有効にする
#5022:LaTeX:Debian/Ubuntuから提供されるdocutilsパケットがクラッシュ
#5009:LaTeX:TABLEにタイトルがない場合、TABLEのラベルは消滅します。
#5048:toctree番号のクラッシュを使用する
#2410:c、マクロのための空パラメータリストを提示します。
C++は,テンプレートパラメータを持たない完全テンプレートに特化した探索を修復した.
#4667:C++、intersphinxを使用した場合のグローバル範囲内の参照不足のアサートが修復されます。アラン·M·キャロルのおかげです
#5019:autodoc:改行文字がクラッシュする
#5032:autodoc:古いスタイルクラスが失われた最初のstaticmethodパラメータ
#5036:クイックスタート:Ctrl-Uでライン全体をクリア
#5066:HTML:デフォルトでは“Relationship”サイドバーは表示されません。
#5091:索引項目のLaTeXが正しく処理されていない:花括弧
#5070:ePub:誤った内部HREFフラグメントリンク
#5104:apidoc:インタフェース
sphinx.apidoc:main()
もう変わった#4272:フランスプロジェクトのPDFバージョンはXeTeXと問題があります。
#5076:ナポレオンはPython 3.7でRuntimeErrorを誘発した
#5125:Sphinx-Build:インタフェース
sphinx:main()
もう変わったライオンのイメージ-内部バージョン:
sphinx.cmd.build.main()
指示を指す.sys.argv
与えられたパラメータではありません#5146:自動要約:1行目の文書文字列が文字記号で終了した場合に警告が発行されます。
自動集計:自動集計警告指示エラー位置(参照:#5146)
#5143:autodoc:ソートがサポートされていないクラス辞書オブジェクトをチェックすると、クラッシュします。
#5139:Autodoc:Enumパラメータが別のパラメータと共有されている場合、パラメータが欠落しています。
#4946:Pyドメイン:rtypeフィールドは、“None”をタイプとして扱うことができません。
#5176: LaTeX: indexing of terms containing
@
,!
, or"
fails#5161:HTML:静的ファイルのコピーに失敗した場合、クラッシュ
#5167:autodoc:2つ以上のパラメータを持つタプルを修復するフォーマットタイプの書き込み
#3329:I 18 N:自動記号脚注による参照クラッシュ
#5158:自動要約:モジュール要約がタイトルで始まるときに中断されました
バージョン1.7.5(2018年5月29日リリース)¶
誤りを修正する¶
#4924:HTML検索:他の言語の大文字問題
#4932:apidoc:同レベルのサブパケットが次の下線の先頭のモジュールを含む場合、いくつかのサブパケットは無視される
#4863、#4938、#4939:I 18 Nは、ディレクトリ、トピック、警告、フォーム、およびチャプタのためのnode.titleを正しく処理できません。
#4913:I 18 N:項目記号リストの文字ブロック未翻訳
#4962:C++重複宣言時にTypeErrorが発生します。
#4825:C++、exprロールを正しく解析し、改行が発生した場合により良いエラーメッセージを提供します。
C++、正しく使用する
desc_addname
名前プレフィックスのノード.C++は,関数呼び出しにおけるパケット拡張を解析する.
#4915、#4916:dirhtmlジェネレータを使用した場合、検索ページのリンクが切断されます。
#4969:autodoc:関数メソッドを構築するには、リターン書き込みを持つべきではありません。
LaTeX:非1で始まる深さ入れ子列挙リストによりLaTeXエンジンが崩壊します
#4978:LaTeX:ブラジルエリアのShort Doffは設定されていません
#4928:I 18 N:LC_MESSAGES/のようなポイントディレクトリを無視する.git/
#4946:PY DOMAIN:TYPEフィールド“None”をタイプとして扱うことができません。
#4979:LaTeX:索引項目の括弧の変換が正しくない
#4956:autodoc:シミュレーションモジュールのクラスのサブクラスからドキュメントを抽出できません。
#4973:LaTeX:Glossaryコマンドは、各アイテムにスペースを追加します。
#4980:LaTeX:コードブロック上の明示的なラベルの繰り返し
#4919:tocotreeが持つ場合:NUMBED:オプションの場合、node.asdom()が崩壊します。
#4914:autodoc:デフォルト値のないデータクラスを使用する場合、解析エラーが発生します。
#4931:autodoc:autoc-Skip-Memberの処理プログラムがエラーを起こした場合、クラッシュ
#4931:autococ:ナポレオンモジュールがアナログクラスのサブクラスを処理した場合崩壊
#5007:エラーログに“%”文字が含まれている場合、Sphinx-Buildが崩壊します。
バージョン1.7.4(2018年4月25日リリース)¶
誤りを修正する¶
#4885、#4887:ドメイン:重複オブジェクトを使用してクラッシュ
#4889:latex:sphinx.writers.latex再帰的導入
バージョン1.7.3(2018年4月23日リリース)¶
誤りを修正する¶
#4769:autocが最初のstaticmethodパラメータを失う
#4790:自動要約:PDFバージョンの2つのリストが広すぎる
#4795:ラテックスを以下のようにカスタマイズする
_templates/longtable.tex_t
壊れています#4789:imgConverter:WindowsのConvert.exeに惑わされる
#4783:Windowsでは、srcdirとoutdirのドライブが異なる場合、Sphinxが崩壊します。
#4812:autodocタイプの注釈付き変数を無視する
#4817:警告メッセージのURLエラー
#4784:LaTeX:
latex_show_urls
入替え項内にハイパーリンクが存在する場合は,誤った脚注番号を割り当てる.#4837:クラス回顧録付きLaTeXエラー:フォントコマンド
\sf
支持しない#4803:LaTeX:自動番号の脚注数に対する割合が遅すぎる
#4838:htmlhelp:.hhpファイルのエントリがソートされていません。
Toctree命令はQUERY_STRINGを持つURLをグローバルに探すことを試みる.
#4871:HTML検索:ドイツ語の大文字問題
#4717:LaTeX:LuaLaTeXおよびXeLaTeXを使用した翻訳ドイツ語文書の作成に失敗
#4459:重複ラベル検出器は、並列構築で正常に動作しない
#4878:無効メタデータを使用した拡張クラッシュ
バージョン1.7.2(2018年3月21日リリース)¶
互換性のない変更¶
#4520:apidoc:フォルダが空 __init__. PYはTOCから除外されなくなりました
誤りを修正する¶
#4669:sphinx.build_mainおよびsphinx.make_mainは名前エラーを誘発します。
#4685:無意味な警告を自動的にまとめる
Autodoc:無効オプションを提供する場合にクラッシュする
Pydomain:空であれば、括弧を常に外してください(参照:#1042参照)
#4689:自動要約:意外に“E”を含む文書文字列を剥離する
#4701:ビューコード:場所を間違えます。
<div>
ビューコードhtml出力では#4444:numfigを必要とせずに使用可能:numref:on sections
#4727:パケットtextCompのオプション競合
#4725:SphinxはPython 3.5.0および3.5.1をサポートしていません
#4716:Windows上でTexLiveを使用してPDFファイルを生成し、ファイルエラーが見つかりません。
#4574:LaTeXの式の前の垂直空間
#4720:画像がビルダと一致しない場合のメッセージが不明
#4655,#4684:ポーランド語および中国語の局所化文字列が不完全である
#2286:HTMLページをレンダリングするとエラーが発生し、Sphinxがクラッシュします。
#4688:長いURLを持つリモート画像のダウンロードエラー
#4754: sphinx/pycode/__init__. PYはAttributeErrorを引き起こした
#1435:qthelpビルダはhtmlscapeキーワードが必要です。
EPub:toc.ncxを修復するdocTitle要素未変換
#4520:apidoc:TOCに含まれていないサブパケット(1.6.6に導入)が修復されました。
#4767:HTML:Mathjax式を破る強調表示を検索する
バージョン1.7.1(2018年2月23日リリース)¶
捨てて使う.¶
#4623:
sphinx.build_main()
賛成しません。自動集約:のインタフェース
sphinx.ext.autosummary.get_documenter()
変更されました(1.7.0から)#4664:
sphinx.ext.intersphinx.debug()
賛成しません。
詳細については、ご参照ください deprecation APIs list
誤りを修正する¶
#4608:ePub:生成されたメタタグは無効です。
#4260:autococ:キーワード·パラメータ·デリミタのみがパラメータリストの上部に存在する場合、消失しません。
#4622:ePub:
epub_scheme
内容に影響を与えない。Opf.#4627:Graphviz:Graphvizイメージをページに適合させる
#4617:QuickStart:PROJECT_DIRパラメータが必要
#4623:1.7.0にsphinx.build_mainはもはや存在しません
#4615:について
sphinx.build
1.7.0で変更されました自動集約:のインタフェース
sphinx.ext.autosummary.get_documenter()
変更されました#4630:sphinx.pot決定性のmsgidをソートする
#4563:自動要約:誤った行尾句読点検出
#4577:間違った明示的な数字で始まる枚挙サブリスト
#4641:ディレクトリの外部リンクに“?”を含めることはできません。使用
:glob:
選択権.C++は,式解析に明示的パターン変換とタイプIDを欠く解析を加えた.
C++は,欠落した解析を追加する
this
式解析では.#4655:ポーランド語の不完全な局所化された文字列を修復
#4653:パラメータなしインポートエラーのレポートの修復
#4664:objects.invの読み込みが再び失敗しました。
#4662:
any
参照:term
曖昧さに遭遇すると目標が崩れてしまう
バージョン1.7.0(2018年2月12日リリース)¶
互換性のない変更¶
1.7.0b1
#3668:各コマンドのマスター関数のパラメータが変更されました。
#3893:未知html_heme_optionsエラーではなく警告を開始します。
#3927:Pythonパラメータ/変数タイプは、すべてのオブジェクトではなく、クラスに一致する必要があります。
#3962:以下の場合、spinx-apidocは、所与のディレクトリを暗黙的名前空間パケットとして識別する。
--implicit-namespaces
与えられたディレクトリのサブディレクトリではなく、所与のオプション。#3929:apidoc:sphinx.apidocをsphinx.ext.apidocに移動する
#4226:apidoc:新しいパターンMakefile(make-mode)の生成
#4274:パラメータがエラーの場合、Sphinx-Buildはログアウトコードとして2を返します。
#4389:拡張をロードすると出力ディレクトリが作成されます。
Autodocは生成された文書に警告メッセージを生成しない.
keep_warnings
本当です。それらはstderrにしか排出されない。Shebang行は生成されたconf.pyから削除する.
#2557:autodoc:
autodoc_mock_imports
指定されたモジュールとその子孫のみをシミュレートする.それは彼らの祖先を笑わない。もしあなたが彼らをあざ笑いたいなら、先祖の名前を明確に説明してください。#3620:HTMLトピック:DOCUMENTION_OPTIONSを独立したJavaScriptファイルに移動(参照:#4295参照)
#4246:すべてのトピックの本文幅を制限します。トピック·オプションで構成可能
body_min_width
そしてbody_max_width
それがそうです。#4771:apidoc:The
exclude_patterns
パラメータがコマンドラインオプションの直後にある場合、パラメータは無視される。
1.7.0b2
#4467:HTMLトピック:名前変更
csss
阻止したcss
捨てて使う.¶
1.7.0b1
文字列の値を使用する
html_sidebars
使用は破棄され、バージョン2.0ではリスト値のみを受け取ります。format_annotation()
そしてformatargspec()
賛成しません。どうぞsphinx.util.inspect.Signature
代わりに。sphinx.ext.autodoc.AutodocReporter
これに代わる.sphinx.util.docutils. switch_source_input()
今はもう人気がありません。それはSphinx-2.0で削除されるだろう。sphinx.ext.autodoc.add_documenter()
そしてAutoDirective._register
今は捨てました。どうぞapp.add_autodocumenter()
代わりに。AutoDirective._special_attrgetters
今は捨てました。どうぞapp.add_autodoc_attrgetter()
代わりに。
追加された機能¶
1.7.0b1
C++、ハンドル
decltype(auto)
それがそうです。#2406:C++、識別子のリンクを含む式の正しい解析が追加されます。
C++に、1つ追加
cpp:expr
連結されたC++式またはタイプのロールを挿入するために使用される。C++では,速記を用いた明示的なメンバインスタンス化をサポートする.
template
接頭辞.C++は,テンプレートパラメータのような関数パラメータをリンク可能にする.
#3638:参照式の変更を許可するラベルの使用
math_eqref_format
今
suppress_warnings
以下の構成を受け入れる:ref.python
(番号:#3866)
#3872:LaTeXキーを追加してPDF出力の文字ブロックタイトル位置を構成します(文献#3792,#1723参照)
文書文字列が欠落している場合は、基本クラスから文書を検索してみてください(参照番号:#3140)
#4023:任意のロールに複数のターゲットがある場合、エラーメッセージを明確にします。
#3973:ePub:オーバーレイ構築日を許可
#3972:ePub:リストエントリをファイル名でソートする
#4052:viewcode:ハイライト表示モジュールコードの前のソート
#1448:qthelp:新しい構成値を追加します。
qthelp_namespace
#4140:HTMLトピック:bodyタグを継承可能にする
#4168:ストリートでzh検索を改善
HTMLトピックは,以下のようにデフォルト側バーを設定することができる.
theme.conf
#3160:HTML:使用
<kdb>
代表しています:kbd:
役柄#4212:自動集約:インポートモジュールを捕捉する際のすべての例外
#4166:追加
math_numfig
式については節番号別の情報である(参考文献:#3991,#4080).オリバー·ヤンのおかげです#4311:ラテックスを服従させる
numfig_secnum_depth
図形、表、コードブロックの場合#947:autoc IGNORE-MODULE-ALL無視モジュールをサポートしています。
__all__
#4332:ラテックスを服従させる
math_numfig
公式番号に使う#4093:Sphinx-build未知のターゲット/ビルダの空ディレクトリの作成
増列する.
top-classes
オプション、使用するsphinx.ext.inheritance_diagram
継承図の範囲の拡張を制限する.#4183:doctest:
:pyversion:
オプションはPEP-440仕様にも従う#4235:HTML:追加
manpages_url
マニュアルページのキャラクターをハイパーリンクに向けるには、以下の操作を実行してください#3570:autodoc:“キー入力中”は表示されません。タイプ提示のためのモジュール
#4354:Sphinx-Build完了メッセージが発行されます。構築者は以下のように修正することができる.
Builder.epilog
属性#4245:HTMLトピック:追加
language
Javascript変数リストへの追加#4079:HTML:追加
notranslate
クラスは各コードブロック、文字、数学に追加され、Google翻訳に翻訳不可能であることが分かるようにします。#4137:doctest:doctestブロックは常にpythonコンソール(Pycon)として強調表示されます。
#4137:doctest:testcodeブロックは常にpythonとして強調表示されます。
#3998:Text:デフォルトでノード番号を割り当てます。以下のツールを使って制御することができます
text_add_secnumbers
そしてtext_secnumber_suffix
1.7.0b2
#4271:Sphinx-Buildサポート名:
-j auto
プロセス数を自動的に調整する.ナポレオン:カスタム部分表記を指定するオプションを追加しました。
削除された機能¶
1.7.0b1
構成変数
html_use_smartypants
latex_keep_old_macro_names
latex_elements['footer']
実用的な方法です
sphinx.application.Sphinx
クラスBuildername(属性)
_display_chunk()
Old_status_iterator()
Status_iterator()
_コマンド_HELPER()
実用的な方法です
sphinx.environment.BuildEnvironment
クラスCurrModule(属性)
Currclass(属性)
Epubb 2構築器
Warn()のプレフィックスとColorFunccパラメータ
sphinx.util.compat
モジュールsphinx.util.nodes.process_only_nodes()
ラテックス環境
notice
使用sphinxadmonition
代わりにラテックス
\sphinxstylethead
使用\sphinxstyletheadfamily
C++,関数概念をサポートする.Mickk-on-CPPのおかげです
未使用で以前に記録されていないLaTeXマクロ
\shortversion
そして\setshortversion
誤りを修正する¶
1.7.0b1
#3882:HTML HelpおよびQTHelpのファイル順序の更新
#3962:spinx-apidoc暗黙的名前空間パッケージを正しく識別できません
#4094:C++テンプレートパラメータリストが空になることができます。
C++におけるハイパーリンクタイプも,名前で宣言された名前を限定したハイパーリンクタイプである.
C++、概念内の宣言に引用項を追加しないでください。
C++,名前に依存したテンプレート曖昧性解消プログラムをサポートする.
#4314:PDF“HOWTO”文書の場合、コードブロックの番号は図および表の番号と異なります。
#4330:PDF“HOWTO”ドキュメントのデフォルトLaex TocDepthカウンタの設定が一致しません。
#4198:複数の‘autodoc-process-docstring’イベントが自動的に集約されます。ジョール·ノースマンのおかげです
#4081:生成時の警告とエラーの色は同じです。
LaTeX:以下の場合,“Release”タグは表示されない.
release
未設定
1.7.0b2
#4415:autoc継承されたクラスメソッドを従来のメソッドに分類する
#4415:autoc継承された静的メソッドを従来のメソッドに分類する
#4472:DOCUMENTION_OPTIONS未定義
#4491:sys.meta_pathでは、AUTODOC:PREFER_MockImporterが他の導入器に優先される
#4490:autodoc:タイプ書き込みとpython 3.7.0 a 4+切断
Utilsパッケージはもうインストールしません
#3952:apidoc:モジュールヘッドの変更
#4275:sphinx.utill.i 18 n.format_date受け入れられるフォーマットが制限されています。
#4493:AutoStructifyが有効になった場合、再マーキングはAttributeErrorを開始します。
#4209:intersphinx:リンクヘッダにおいて、ターゲットがバージョンされていない場合、“v”はオプションであるべきである。
#4230:ライオン画像1.6を使用してページを作成すると速度が遅くなります
#4522:ePub:構成が変更されても、ドキュメントは再構成されません。
1.7.0b3
#4019:INSTERATIONATION_DATTRUMENT AttributeError Makeプロセスの停止
#4531:自動要約:メソッドはプロパティとはみなされません
#4538:autodoc:
sphinx.ext.autodoc.Options
移動されています#4539:autodocメソッドの一部を警告する
#4223:doctest:誤ったファイル、誤った行でテスト失敗を報告する
I 18 N:指定されたファイル名にメッセージディレクトリが指定されていれば,メッセージディレクトリをコンパイルしない.
sphinx-build
パラメータとして(参考文献:#4560)#4027:sphinx.ext.autosetionlabelは、元のソースコードのラベルと同じラベルであることを望みます。スマート引用符がなく、派手さがありません。
#4581:apidoc:除外されたモジュールはまだ含まれています。
バージョン1.6.7(2018年2月4日リリース)¶
誤りを修正する¶
#1922:HTML検索:フランス語の大文字問題
#4412:jQueryバージョン3.1.0から3.2.1に更新
#4438:MATH:スペース付きラベルを使用したMATHによりhtmlエラーが発生します。
#2437:完全引用クラス、別名“alias of”
#4434:純粋な数字がリンク先として警告を生成します。
#4477:特定のファイルの生成後の生成に失敗しました。
#4449:apidoc:モジュールを含む“空”パケット
#3917:参照ラベルの省略番号への変換
#4501:Graphviz:グラフィックスがクリックできない場合、EPUB 3検証エラーになります。
#4514:Graphviz:Graphvizによって生成されたエラーマップIDの解決方法
#4525:autosetionLabelは並列構築をサポートしていません。
#3953:ジョブのIntersphinxリストが存在する場合、警告を出さないでください。
#4487:数学:ValueErrorは、並列生成時に開始されます。Jschuellerのおかげです。
#2372:自動要約:タイプ注釈関数表示無効署名
#3942:HTML:フォームが真ん中に位置していなくても
:align: center
バージョン1.6.6(2018年1月8日リリース)¶
追加された機能¶
#4181:autodoc:辞書キーワードを可能な限りソートする
VerbatimHighlightColor
新しいのです LaTeX 'sphinxsetup' キーワード(参考文献:#4285)現代のブロックに関連するLaTeXマクロをカスタマイズしやすくなります
Conf.pyが異常を起こした場合、バックトラックが表示されます(参照:#4369参照)
増列する.
smartquotes
スマートオファーを無効にするためには、以下の操作を実行してくださいconf.py
(参考文献:#3967)増列する.
smartquotes_action
そしてsmartquotes_excludes
(参考文献:#4142,#4357)
誤りを修正する¶
#4334:spinx-apidoc:TOCに存在しないファイルへの参照は生成されません
#4206:LaTeX:段落間の静止ラベル損失改行
#4231:HTML:FirefoxでのみFirefox AnclBugを適用する
#4221:ナポレオンはautocに依存していますが、ユーザーは手動でロードする必要があります。
#2298:自動モジュールはクラス属性を記録できません
#4099:C+:構造関数の内部からクラス参照を正しくクラスにリンクする
#4267:Unicode U+2116 Numero記号文字で中断されたPDF内部バージョン
#4249:PDF出力:Pygmentsエラー強調表示コードブロックの行距離が増加しました。
#1238:サポート
:emphasize-lines:
PDF出力では#4279:複数のプロセスおよびリモートイメージを使用して実行されると、酸洗エラーによりSphinxが崩壊します。
#1421:ライオンの顔像を尊重する静かな旗--クイックスタート
#4281:出力ディレクトリを作成する際の競合条件
#4315:PDF“HOWTO”ドキュメントの場合、
latex_toplevel_sectioning='part'
生成\chapter
指令#4214:2つのtodolistコマンドによるライオンのイメージの破壊-1.6.5
外部オプション文書へのリンクは、intersphinxを使用して修復されます(参照:#3769参照)
#4091:記録されていないプライベートメンバー:UNDOC-Members:
バージョン1.6.5(2017年10月23日リリース)¶
追加された機能¶
#4107:searchtools.jsをSphine 1.5に準拠させる前のテンプレート
#4112:SMART_QUOTES設定が設定されている場合、設定を上書きしない
#4125:I 18 N警告メッセージに原文および翻訳文が表示される参照テキスト
#4147:ログPO/MOファイルの読み書きに異常が含まれています。
誤りを修正する¶
#4085:解析文字を使用した画像からのPDF生成に失敗
:align:
選択権.#4100:Autodoc拡張からのデバッグ印刷の削除
#3987:雪花石膏からのトピック変更は、HTML構築に失敗します。
#4096:C++、誤ったロール·タイプを使用して崩れないようにします。Mitya 57のおかげである.
#4070、#4111:警告メッセージがフォーマット文字列を含む場合(再度)クラッシュ
#4108:検索語の強調表示中断SVG画像
#3692:書き込み.buildinfoに失敗した場合、HTMLを生成できません。
#4152:文書の上部にフィールドリストが配置されている場合、HTMLライタがクラッシュする
#4063:コマンドをマークすると、Sphinxが崩壊します。
.. todolist::
#4134: [doc]
docutils.conf
はっきりした記録がない#4169:中国語は自動的に中国語検索をトリガできません
#1020:ext.todo Todolist pdflatexにリンクされていないページ
#3965:Makefileでエラーを生成した新しいクイックスタートSPHINXBUILD
#3739:
:module:
オプションはpyObjectsの内容で無視されます#4149:ドキュメント:ヘルプ選択
latex_engine
#4090: [doc]
latex_additional_files
もし追加のLaTeXマクロがあれば、使用すべきではありません.tex
延伸する.RESTパーサを警告に誤変換できません(参照:#4132参照)
バージョン1.6.4(2017年9月26日リリース)¶
追加された機能¶
#3926:追加
autodoc_warningiserror
…を抑圧する.の行為です。-W
AutoDocへのターゲットモジュールの導入中のオプション
誤りを修正する¶
#3924:動的解析拡張のRSTの後にdocnameが失われます。
#3946:sphinx.stedのスペルエラー(デフォルトコンテキストで無効なエラーです)
- ペップ.
と:rfc:サポートしない
default-role
コマンド(参考文献:#3960)
#3960:DEFAULT_ROLE=‘Guilabel’は機能しません。
行方不明
texinputs_win/Makefile
Windows上のlatexpdf生成器で使用した.#4026:自然:MacOS Safariローリングバーの色を修復
#3877:C++複数行の署名が修復されました。
#4006:並行構築におけるクラッシュの修復
#3969:プライベート·インスタンス·プロパティの結果、AttributeError
#4041:C++、関数ポインタの余分な名前リンクを削除します。
#4038:C、欠落ドキュメントを追加
member
役。#4044:空の多列セルにより、PDF出力に追加の行高が発生します。
#4049:sphinx-build-h出力のスペルエラーを修復します。
#4062:Python 3では、hashlib.sha 1()はUnicodeではなくバイトを採用しなければなりません。
LaTeX内のインデックス項目の後のインデントを避ける(参考文献:#4066)
#4070:警告メッセージにフォーマット文字列が含まれている場合にクラッシュする
#4067:Makeサブプロセスが失敗した場合、非ゼロ終了状態に戻る
#4055:raphviz::Align:SVG出力にはオプションが適用されません。
#4055:raphviz::ALIGN:CENTERオプションはLaTeX出力には適用されません。
#4051:
warn()
HTMLトピックが“None”文字列を出力する関数
バージョン1.6.3(2017年7月2日リリース)¶
追加された機能¶
LaTeX:プロンプトコードブロックを次のページに続ける(参照番号:#3764,#3792)
誤りを修正する¶
#3821:docutils-0.14 rc 1 sphinx.utill.compatの導入ができません
#3829:Sphinx-QuickStartテンプレート雪花石膏の使用について不完全
#3772:‘Str Object’属性‘filename’がありません。
引用タグにハイフンが含まれている場合は、エラー警告を発行します(参考文献:#3565参照)
#3858:-colorオプションを使用する場合、いくつかの警告は着色されません。
#3775:デフォルト·テンプレートの不要なスペースの削除
#3835:プロジェクトディレクトリ名にスペースが含まれている場合、sphinx.ext.imgathはSVGイメージを変換できません。
#3850:Makeモードを修復するヘルプコマンドのカラー処理
#3865:sphinx拡張でself.env.warnを使用して失敗しました。
#3824:Sphinx 1.6.1以降、生産リストアプリケーションのスマートオファー変換
LaTeX:修復
\sphinxbfcode
論点の先頭スペースを飲み込む#3878:PDF出力では、自動記録されたクラス属性の引用符は直接引用符であるべきです。
#3881:次のページにスライドしたラテックスパターンには、追加の垂直スペースが残る場合があります。
#3885:脚注を繰り返すことでインデックスエラーが発生
#3873:警告メカニズムの廃棄は失敗しました。
sphinx.util.compat.Directive
#3874:ファイル間参照の“引用されていない”の虚偽の警告
#3860:ビルダがミラーリングをサポートしていない場合、イメージをダウンロードしない
#3860:ファイル名デリミタビルダを持たないリモート·イメージURIは、リモート·イメージをサポートしていません。
#3833:コマンド·ライン·メッセージが意図せずに変換されます。
language
セット。#3840:チェックを行う
epub_uid
手厳しい#3851、#3706:PDF出力を修復するブロック·ペイント文字
#3900:自動まとめで方法が見つかりません
#3902:エラーが発生した場合
latex_documents
Py 2には非Unicode文字列が含まれている
バージョン1.6.2(2017年5月28日リリース)¶
互換性のない変更¶
#3789:Python>=3.5類型化モジュールは不要
誤りを修正する¶
#3754:HTMLトピックに自分のスタイルテーブルを追加すると、HTMLビルダが崩壊します。
#3756:ePub:未定義エンティティ‘mdash’
#3758:conf.pyにログが発行された場合、Sphinxは崩壊します。
#3755:使用テキストに含まれるDEDENTを誤って警告
#3742: RTD Sphinx自身の文書のPDFバージョンは,ブックマークやディレクトリにインデックス項目が欠落している.これは.。 rtfd/readthedocs.org#2857 この問題はSphinx自身の追加のLaTeXコードを使用して解決することができます
conf.py
#3770:“コードブロック”が強調行オプションを有し、ライン数よりも多い数を示す場合、生成に失敗します。
#3774:参照時のインクリメンタルHTMLを使用した構築中断
#3763:epub_coverが設定されている場合、epubcheck検証エラーを取得します。
#3779:‘sys.meta_path’によって、sphinx.ext.autodocの‘ImportError’が破損します。タティアナ·トレシェンコのおかげです
#3796:非文書ノードが与えられたとき、env.Resolve_References()が崩壊する
#3803:Sphinxが崩壊し、POファイルが無効になります。
#3791:ロングテーブルPDF“次ページ続”国際化されていません
#3788:スマート引用符がサポートされていない言語に警告する
#3807:LaTeX Makefile
make latexpdf
Unixenにのみ適用されます#3781:Optionコマンドの2ハイフンが末尾番号にコンパイルされます。
#3817:Laex BuilderはAttributeErrorを誘発する
バージョン1.6.1(2017年5月16日リリース)¶
依存性.¶
1.6b1
(更新)LaTeX出力Ubuntu Trustedのtexliveパッケージを使用してテストを行い(2014年2月)、初期のTeXインストールは完全に互換性がない可能性があり、特にUnicodeエンジンxelatexとlualatexについて
(追加)以下の項にlatexmkが必要
make latexpdf
GNU/LinuxおよびMac OS Xで(参照:#3082)
互換性のない変更¶
1.6b1
#1061、#2336、#3235:デフォルトでインポートメンバが含まれていないことを自動的にまとめて生成します。リュック·サヴルのおかげです。
ラテックス
\includegraphics
命令は再ロードされていない:のみ\sphinxincludegraphics
画像が大きすぎるときに利用可能な幅に適合させるためのカスタムコードを有する。の子類
sphinx.domains.Index
カバーすべきだgenerate()
方法です。デフォルトの実現はNotImplementedErrorを引き起こすLaTeXは長いテーブルを水平に真ん中に置き,短いテーブルは左に整列する(テーブルの周りに文字の流れがない).この2つの場合、位置は現在デフォルトで中心であり、Docutils 0.13に準拠する。
:align:
オプション(参考文献#3415,#3377)オプション指示はまた、オプション名がすべての句読点を使用することを可能にします(参照:#3366参照)
#3413:もし
literalinclude
張氏.:start-after:
ご利用の際は、作成してください:lines:
相対(参考文献番号3412)literalinclude
命令は組み合わせを許さない:diff:
オプションおよびその他のオプション(参照番号:#3416)LuaLaTeXエンジンは
fontspec
例えばXeLaTeXです私たちは提案しますlatex_engine = 'lualatex'
最新のTeXインストールのみ(文献#3070、#3466参照)latex_keep_old_macro_names
デフォルト値はTrue
toFalse
. This means that some LaTeX macros for styling are by default defined only with\sphinx..
接頭辞名。(参考文献:#3429)LaTeX Long Tableのページ“次のページ続”は現在枠が入っていません(参考文献:#3497)
#3529:概要
BuildEnvironment.__init__
変更されました#3082:pdf(およびdvi)ターゲットにlatexmk(クラスUnixプラットフォームのみ)を使用する
#3558:脚注および引用文が参照されていない場合、警告が発行されます。警告は以下のようにキャンセルできます
suppress_warnings
それがそうです。LaTeXは,Plain Texのpdftexエンジンとともに配布されたファイルから(未記録の)色マクロを提供する.このオプションを削除するのは、複数のTeXエンジンをより良くサポートするためです。以下の位置からのインタフェースのみ
color
あるいは…。xcolor
パケットはSphinx LaTeX Writerの拡張によって使用されるべきである.(参考文献番号3550)Builder.env
インスタンス化時には充填されていない#3594:LaTeX:単一のRAW命令は、ブロックレベル要素として扱われています。
#3639:もし
html_experimental_html5_writer
利用可能であり、epub Builderはそれをデフォルトで使用する。Sphinx.add_source_parser()
繰り返すと誤りを引き起こす
1.6b2
#3345:カスタムSmartyantsコードをDocutilsのSMART_QUOTESで置き換える。Dmitry ShachnevとDocutilsのGünter Mildeに感謝します。
1.6b3
ラテックス包装
eqparbox
Sphinxでは使用されずロードされていますラテックス包装
multirow
Sphinxでは使用されずロードされていますSTDドメイン中の引用文データに行番号を付加する
1.6決勝戦
ラテックス包装
threeparttable
Sphinxによる使用およびロードはもはや行われていない(文献#3686、#3532、#3377参照)
削除された機能¶
構成変数
epub3_contributor
epub3_description
epub3_page_progression_direction
html_translator_class
html_use_modindex
latex_font_size
latex_paper_size
latex_preamble
latex_use_modindex
latex_use_parts
termsep
ノード.ノード定義.htmlテンプレート
LDML format support in
today
,today_fmt
andhtml_last_updated_fmt
:inline:
Sphinx.ext.raphviz拡張命令のオプションSphinx.ext.pngath拡張子
sphinx.util.compat.make_admonition()
追加された機能¶
1.6b1
#3136:追加
:name:
中の指示のオプションsphinx.ext.graphviz
#2336:追加
imported_members
選択権.sphinx-autogen
導入したメンバを命令記録する.C++、追加
:tparam-line-spec:
テンプレート化宣言のオプション。指定されると、各テンプレートパラメータは別個の行に提示される。#3359:ユーザーエリア設定ディレクトリ内のsphinx.jsがSphinxからsphinx.jsを上書きできるようにする
#3303:追加
:pyversion:
オプションはdoctestコマンドに追加されます。#3378:(LaTeX)サポート
:widths:
表コマンドオプション(参考文献:#3379、#3381)#3402:以下のコマンドを使用して“ファイルをダウンロードできない”警告を抑制することを許可する
suppress_warnings
それがそうです。#3377:LaTeX:Docutils 0.13のサポートを追加
:align:
オプションはテーブルに使用される(ただし,テーブルの周囲のテキストの流れは実現されない).LaTeX:フォーム内部の脚注はハイパーリンクである(ヘッダやヘッダを除く)(参考文献:#3422)
超過が検出された場合は、警告を発します
literalinclude
コマンド(参考文献:#3416)LuaLaTeXがXeLaTeXと同じデフォルト設定(すなわち
fontspec
そしてpolyglossia
)。(参考文献:#3070,#3466)製造
'extraclassoptions'
のキーワードです。latex_elements
公開(参考文献番号3480)#3463:必要なEPUB 3メタデータに警告メッセージを追加します。デフォルト値を追加する
epub_description
他の設定のように警告を発することを避けるために。#3476:setuptools:複数のビルダをサポート
LaTeX:LaTeXテーブルに統合されたセルは、コードブロック、リスト、ブロック引用符を可能にします...正常細胞も同様です(参考文献:#3435)
HTMLビルダは実験的HTML 5コンパイラIFを用いた.
html_experimental_html5_writer
Trueであり、docutils 0.13以上がインストールされている。PDF出力におけるテーブルの前後間隔をカスタマイズするためのLaTeXマクロ(参照番号3504)
#3348:テキスト包含およびビューコード命令に装飾子を表示する
#3108:start-at:他のテキストとオプションがテキストと一致しない場合、警告が表示されます。
#3609:“重複参照”のキャンセル警告の使用が許可されます。
suppress_warnings
#2803:入口ポイントで構築器を発見
#1764,#1676:スタイルテーブルの‘rel’および‘title’のプロパティの設定を許可します。
#3589:非HTMLビルダでリモートイメージをサポート
#3589:非HTML生成器でデータURIのイメージがサポートされています。
#2961:改善
autodoc_mock_imports
それがそうです。現在,配置値はシミュレーションすべきトップモジュールのみを宣言すればよい.ロビン·ジャリーのおかげです#3449:py 3では、autocはチェック署名を使用して、署名をより正確に計算することができる。ナサニエル·J·スミスのおかげです
#3641:ePubトピックは、HTML 5ライタによって生成されたHTML構造をサポートします。
#3644 Autodocチェックタイプではなく、チェックを使用します。ジェレン·デミエのおかげです
新しい拡張名を追加します。
sphinx.ext.imgconverter
それがそうです。文書中の画像をビルダに適したフォーマットに変換するLaTeX:テンプレートレンダリングテーブルを用いる(文献#3389,2 a 37 b 0 e参照)
1.6b2
LATEXMKOPTS
ファイルを生成する変数$BUILDDIR/latex
選択肢を伝えるにはlatexmk
実行時にmake latexpdf
(参考文献番号3695,#3720)新しい事件を追加する
env-check-consistency
拡張の一貫性をチェックするには、以下の操作を実行してください増列する.
Domain.check_consistency()
一貫性をチェックするには、以下の操作を実行してください
誤りを修正する¶
1.6b1
literalinclude
コマンド削除後にタブを展開します(参照:#3416参照)#1574:表セル中のパラグラフはLatex出力では機能しない
#3288:マージタイトルを持つフォームはテキストを変更しません
#3491:PDFの表と長テーブルの周囲の垂直空間が一致しません。
#3506:HTMLコンパイラのすべての警告の分離関数が正しく伝達されるようになりました。
node
至るdepart_admonition
それがそうです。#2693:Sphinx LaTeXスタイル·ファイルは、LaTeX+DVI(ps、pdf、pdfmx)の部分タイトルの色を誤って禁止します。
C++、正しく検索
any
参考資料。#3624:sphinx.ext.intersphinx gzipで圧縮されたリストをロードできません。
#3551:PDF情報辞書の著者およびタイトルデータが欠落している
#3351: intersphinx does not refers context like
py:module
,py:class
and so on.親テンプレートがアーカイブされている場合、テンプレート·ファイルをロードすることはできません
1.6b2
#3661:Sphinx-Buildが並列構築時に崩壊
#3669:gettext生成器に失敗し、“ValueError:Substring Not Found”を表示します。
#3660:Sphinxは常にsphinxcontrib-websupportとその依存性に依存しています。
#3472:LaTeXのスマート引用符のエラー(少なくともAutoAttributeによる文字列リストの使用)(参照:#3345、#3666参照)
1.6b3
#3588:以下の場合でも、i 18 nドキュメント構築ではコンパクト(pタグ)html出力がありません。
html_compact_lists
本当です。♪the
make latexpdf
1.6 b 1から(GNU/LinuxおよびMac OSの使用latexmk
)LaTeXエラーが発生した場合にはハードコード使用が原因で1.5シリーズよりも早く中止される--halt-on-error
オプション(参考文献番号3695)#3683:デフォルトではsphinx.websupportモジュールは提供されません。
#3683:builder.css_file.insert()を呼び出すと、文書を生成できません。
#3714:ビュー·コード拡張が使用されていない
highlight_code='none'
帳簿につける.#3698:移動中:DOC:STDドメインへの後方互換性の打破
#3633:参照されていない参照の誤検出
1.6決勝戦
LaTeXテーブルは,見出しユニット格に複数のパラグラフが存在することを許さない
1.6 b 3からLATEXOPTSはpdflatexに正しく渡されていない
#3532:短いフォーム要素格のグラフィックスまたは文字ブロックタイトルは、PDF出力に深刻な影響を与えます。
FIX:PDFでは,フォームがLong tableクラスに属するか否かにかかわらず,テーブルの字幕提示方式が異なる(参照番号3686).
#3725:LaTeX出力では、TODOはNOTEとは異なるように見える
#3479:スタブ列はLaTeX出力に影響を与えません
#3738:heming.pyの無意味なコード
#3746:オプションが定義されていないため、latexmk 4.48以降のPDFの生成に失敗しました。
-pdfxe
そして-pdflua
捨てて使う.¶
1.6b1
sphinx.util.compat.Directive
class is now deprecated. Please use insteaddocutils.parsers.rst.Directive
sphinx.util.compat.docutils_version
今は捨てました。#2367:
Sphinx.warn()
,Sphinx.info()
and other logging methods are now deprecated. Please usesphinx.util.logging
(ログAPI) instead.#3318:
notice
現在はLaTeX環境名として使用されておらず、Sphinx 1.7で削除される。拡張著者はご利用くださいsphinxadmonition
代わりに(Sphinxが1.5からやったように)。Sphinx.status_iterator()
そしてSphinx.old_status_iterator()
今は捨てました。どうぞsphinx.util:status_iterator()
代わりに。Sphinx._directive_helper()
賛成しません。どうぞsphinx.util.docutils.directive_helper()
代わりに。BuildEnvironment.set_warnfunc()
今は捨てました。以下の方法に従う
BuildEnvironment
今は捨てました。BuildEnvironment.note_toctree()
BuildEnvironment.get_toc_for()
BuildEnvironment.get_toctree_for()
BuildEnvironment.create_index()
どうぞ
sphinx.environment.adapters
代わりにモジュールがありますラテックス包装
footnote
バンドルされた代替項によってロードされなくなりましたfootnotehyper-sphinx
それがそうです。再定義されたマクロは,オリジナルパッケージと同じ名前を保持する.#3429:構成設定の使用は推奨されていません
latex_keep_old_macro_names
それがそうです。1.7バージョンで削除され、そのデフォルト値はTrue
至るFalse
それがそうです。#3221:epubb 2生成器は破棄されました。
#3254:
sphinx.websupport
現在は独立したソフトウェアパッケージに分類されていますsphinxcontrib-websupport
それがそうです。sphinx.websupport
Sphinx-2.0で削除されます。#3628:
sphinx_themes
ENTRY_POINTは廃棄されました。どうぞsphinx.html_themes
代わりに。
1.6b2
#3662:
builder.css_files
賛成しません。どうぞadd_stylesheet()
APIではありません
1.6決勝戦
ラテックス
\sphinxstylethead
1.6版では破棄され,1.7版で削除される.カスタム項を新しいマクロに移動してください\sphinxstyletheadfamily
それがそうです。
バージョン1.6(未リリース)¶
未リリース(パッケージスクリプトエラーのため)
バージョン1.5.6(2017年5月15日リリース)¶
誤りを修正する¶
#3614:要求付きSphinxクラッシュ-2.5.0
#3618:タプルパラメータ付きautocクラッシュ
#3664:Sphinx製LaTeXリストプロジェクトでは、プロジェクトの後ろにスペースがありません。
#3657:genindexで始まるドキュメントが存在する場合、ePub Builderは崩壊します。
#3588:以下の場合でも、i 18 nドキュメント構築ではコンパクト(pタグ)html出力がありません。
html_compact_lists
本当です。#3685:サードパーティドメイン名を使用する場合、AttributeErrorが発生します。
#3702:ラテックス作家がハードコードで人物伝説を形作る
\small
#3708:Laex Writer許可IRCスキーム
#3717:強制お気に入りクリップアイコンを停止するには.icoが必要です。
#3731、#3732:非クラスパラメータからis列挙述語を保護する
#3320:コンテナタイプの参照対象が見つからない警告
LaTeX構築ライブラリのMakefileにおけるARCHIVEPREFIXスペルエラー
バージョン1.5.5(2017年4月3日リリース)¶
誤りを修正する¶
#3597:与えられた名前が無効である場合、PythonドメインはUnbound LocalErrorを開始します。
#3599:新しいMathJax CDNへの移行
バージョン1.5.4(2017年4月2日リリース)¶
追加された機能¶
#3470:アルファベットだけではなく、genindexをすべてサポートします。
誤りを修正する¶
#3445:設定
'inputenc'
重要なのは\\usepackage[utf8x]{{inputenc}}
PDF構築に失敗しましたEPubファイルはコピーされました
nav.xhtml
リンクしていますcontent.opf
最初の構築を除いて#3488:以下の場合、objects.invが破損しています。
release
あるいは…。version
リターンコードが含まれています#2073、#3443、#3490:内容が同じでなければ作成日がない限り、POTファイルを書き込むためのgettextビルダ。柴川義貴のおかげです。
#3487:intersphinx:参照オプションが失敗しました。
#3496:LaTeX Long tableの最後の欄は、内容よりもはるかに広い場合があります。
#3507:ProductionListコマンドのLaTeX出力の引用符エラー
#3533:Sphinx 1.3.1から1.5.3への移行は、コード形式で提示されるリンクのLaTeXコンパイルを破壊します。
#2665,#2607:C++ドキュメントフィールドの名前をリンクし、他のドメインでの使用を許可します。
#3542:C++、テンプレートを使用して非タイプのテンプレートパラメータの解析エラーを修復します。
#3065、#3520:Pythonドメインではネスト·クラスを識別できません。
#3575:ライオンの顔像で構築されたトルコ文書中のpdflatex問題が再発しました(文献#2997,#2397参照)
#3577:intersphinxデバッグツールの修復
LaTeXコマンドは
\\large
見出し項に挿入するlatex_documents
PDF構築に失敗しました(参考文献#3551,#3567)
バージョン1.5.3(2017年2月26日リリース)¶
追加された機能¶
サポート要求-2.0.0(試験)(参考:#3367)
(LaTeX)PDFページ辺距離サイズはカスタマイズ可能です(参照番号:#3387)
literalinclude
指令許容組み合わせ:pyobject:
そして:lines:
オプション(参考文献:#3416)#3400:生成モード文書構築時にサブプロセスを使用しない
誤りを修正する¶
#3370:コードブロックタイトルが抽出されていない翻訳
ラテックス:
release
未転義(参考文献:#3362)#3364:Sphinx-QuickStartプロンプトがコンソール上でオーバーフローし、幅80文字
1.5からPDFのディレクトリとブックマークに共通インデックスエントリが欠落している(参照番号:#3383)
#3392:
'releasename'
はい。latex_elements
機能しません#3356:日本語ページのレイアウト
'manual'
Docclassのテキスト領域は短い#3394:いつ
'pointsize'
いえ。10pt
、日本語'manual'
文書取得エラーのPDFページサイズ#3399:QuickStart:conf.pyはテンプレートに上書きされていません
#3366:Optionコマンドでは句読点の使用が許可されていません
#3410:リターンコード
release
Html検索を中断する#3427:autoc:Windows上の剥離されていないメモリアドレス
#3428:fontspec v 2.6定義のため、xetex構築テストに失敗しました。
\strong
#3349:結果
IndexBuilder.load()
壊れています#3450: がEPUBドキュメントに表示されます。
#3418:検索ボタンの性質とピラミッドのトピックが一致していません。
#3421:翻訳できないタイトル
#3552:リンクチェックによるUnbound LocalError
バージョン1.5.2(2017年1月22日リリース)¶
互換性のない変更¶
依存性要件更新:要求2.4.0以降(参照:#3268、#3310)
追加された機能¶
#3241:タイトルに問題がある場合、ラテックス警告を発行します(参照番号3210)
#3194:$MAKE環境変数を参照して決定
make
命令する.入れ子番号ディレクトリツリーに警告(参照:#3142)
#978:
intersphinx_mapping
リストをパラメータとすることも許可されています#3340:(LaTeX)長い列に並ぶ parsed-literal 包まれているようなものです
code-block
内連数学と脚注機能が揃っています。
誤りを修正する¶
#3246:xapian検索アダプタのクラッシュ
#3253:Py 2環境では,字幕なしtoctreeを用いて別の言語環境を構築すると生成される.
None
説明する.#185:元のノードを含むノードタイトルへの参照が中断された
#3255:Py 3.4環境では、autocは正しいEnumクラス属性文書をサポートしていません。
#3261:
latex_use_parts
ライオンの顔を墜落させる警告タイプ
misc.highlighting_failure
役に立たない#3294:
add_latex_package()
衝突を非ラテックス建築業者にしますフォームタイトルが無効になったHTML(参照:#3287参照)
#3268:SphinxはDebian Jessieの要求パケットで崩壊します。
#3284:Sphinxが並列構築時に崩壊し、拡張子が直列化できない異常を引き起こす
#3315:docclass“回顧録”のLaTeXバージョンで参考文献が崩壊しました。
#3328:トピックを暗黙的に参照できません
#3329:poファイルが無効で、読み取りができない場合に警告します。型も書いています
#3337:リスト用語分類器の醜いレンダリングを定義する
#3335:gettext field_listのフィールドのfield_nameは抽出されません。
#2952:C++、Operator()関数への参照を修復します。
修復中のUnicodeの上と下の数字
code-block
解析文字LaTeX出力(参照番号3342)ラテックス作家:離れて
"
解析した内部文字-元様文字(参照番号3341)#3234:符号化リストのintersphinxは失敗しました。
#3158:PDF出力に字幕後のスペースが多すぎます
#3317:ハイフンを使用する場合、解析テキストコンテンツのURLがPDFにエラーを提示します。
解析文字形式で挿入された画像のファイル名にハイフンが含まれている場合、LaTeXは崩壊する(REF#3340)
解析された文字に脚注を挿入したLaTeXレンダリング誤り(参照番号3340)
LaTeXは解析文字の連結数学をうまく表現できない(REF#3340)
#3308:pdf builderを使用して、解析された文字の改行が長くなりません(Ref#3340)
#3295:拡張子sphinx.builders.linkcheckの導入ができません
#3285:自動集計:星号転義2回
LaTeX,dvipdfmオプションを日本語文書の幾何学パッケージに渡す(参照番号3363)
修復parselinenos()は左半開放範囲を解析できません(参照)“-4”)
バージョン1.5.1(2016年12月13日リリース)¶
追加された機能¶
#3214:epub Builderの使用禁止による“未知のmimetype”警告の使用が許可されます。
suppress_warnings
それがそうです。
誤りを修正する¶
#3195:並列構築できません
#3198:toctreeに‘self’がある場合AttributeErrorを引き起こす
#3211:未翻訳のライオンの顔画像領域設定ディレクトリを削除(未翻訳のit_ITに含まれています)
#3212:HTML生成器のdocutilsを使用したクラッシュ-0.13
#3207:テキストコマンドの参照を解析するには、LaTeXの問題がより多く存在します。 (
\DUrole
)#3205:sphinx.utill.request古いpyOpenSSLを使用したクラッシュ(<0.14)
#3220:KeyErrorが繰り返し参照される場合
#3200:desc_nameでのLaTeXの使用は許可されていません:xref
#3228:
build_sphinx
依存項が不足している場合は命令が崩壊する#2469:gettext生成器の書き出しファイル更新を無視します。大久保弘のおかげです。
#3183:生成されたインデックスページ·ジャンプボックスを順次ランダム化します。
バージョン1.5(2016年12月5日リリース)¶
互換性のない変更¶
1.5a1
LaTeX,Package FancyBoxはsphinx.stedに依存しなくなった.
使用
'locales'
デフォルト値としてlocale_dirs
LaTeX,Package If Thenはもはやsphinx.styの依存項ではない
Laex,Styleファイルはfancyvrbの逐語を修正しないが(OriginalVerbatimとして提供されてもよい),カスタムラッパの名前としてsphinxVerbatimを用いる.
LaTeXは,パケットnewFloatが使用されなくなった(も含まれていない)(REF#2660;1.3.4から使用し,1.4からSphinxとともに提供される).
Laexは,表中の文字ブロックはOriginalVerbatimではなく,タイトルと改行を扱うsphinxVerbatimintable(Ref#2704)を用いる.
ラテックス、交換
pt
Texに相当するbp
もし次の位置で見つけたらwidth
あるいは…。height
画像の属性。ラテックス、もし
width
あるいは…。height
画像の属性は単位が付いていませんので、ご利用くださいpx
無視するのではありませんLaTeX:偽装されたスタイルテーブルを独立した.stedファイルに分離する.
#2454:SourceLinkのファイル名が変更されました。の価値
html_sourcelink_suffix
元のファイル名に添付されます(例えば、index.rst.txt
)。sphinx.util.copy_static_entry()
今は捨てました。使用sphinx.util.fileutil.copy_asset()
代わりに。sphinx.util.osutil.filecopy()
ファイルが変更されていない場合は、コピーをスキップします(番号:#2510、#2753)JQueryバージョンが1.11.0から3.1.0に更新されたため、Internet Explorer 6-8、Opera 12.1 x、またはSafari 5.1+サポートが削除されました(参照:#2634、#2773参照)
QtHelpBuilder検索ページを生成しない(参照:#2352)
QtHelpBuilder使用
nonav
デフォルトの主題ではなく、主題は可読性を向上させる。LaTeX:日本語文書に良好なデフォルト設定を提供するために、Sphinxを使用する
jreport
そしてjsbook
Docclassとしてlanguage
はい。ja
それがそうです。sphinx-quickstart
プロジェクトのバージョンを空にすることを許可しておりますFIX:Download:epub/qthelp builder上の役割.彼らは彼らがそれを支持しないので、この役割を無視した。
sphinx.ext.viewcode
デフォルトの場合はepub構築には適用できない.viewcode_enable_epub
選択権.sphinx.ext.viewcode
Singlehtml生成器で無効にします。使用した生成モデル
sphinx-quickstart
デフォルトの場合。この機能を無効にするには、ご利用ください-M
選択権.手入れをする.
genindex.html
,Sphinxの文書テンプレートは,xhtml基準を満たすようにアドレスを自身にリンクする.デフォルトの場合はEPUB 3生成器を使用する.古いepub生成器はepub 2と改名される.
手入れをする.
epub
そしてepub3
以下の項へのリンクを含むビルダgenindex
たとえepub_use_index = False
それがそうです。html_translator_class
今は捨てました。使用Sphinx.set_translator()
APIではありませんPython 2.6および3.3のサポートをキャンセル
EPUB 3生成器の削除
epub3_page_progression_direction
オプション(使用)epub3_writing_mode
)。#2877:名前変更
latex_elements['footer']
至るlatex_elements['atendofbody']
1.5a2
#2983:名前を変更する
epub3_description
そしてepub3_contributor
至るepub_description
そしてepub_contributor
それがそうです。トピック/basic/findex.htmlを削除する;もはや使用しない
SphinxはLaTeXスタイルファイルを提供しなくなりました
fncychap
#2435:痩身クイックスタートconf.py
♪the
sphinx.sty
LaTeXパッケージはLaTeX出力の前文で採択されるため、自身の“Hyperref”をロードしない。'hyperref'
鍵です。Sphinxはカスタム修正されたLaTeXスタイルファイルを提供しなくなりました
tabulary
それがそうです。未修正のバッグを使います。#3057:デフォルトの場合、LaTeX PDF出力の脚注マークの前にスペースがなくなりました。
\sphinxBeforeFootnote
必要であれば,ユーザのカスタマイズを許可する.LaTeXターゲットにはこのオプションが必要です
hyperfootnotes
小包の数量hyperref
デフォルト値を変更しないようにする(すなわち、true
)(参考文献:#3022)
1.5決勝戦
#2986:
themes/basic/defindex.html
今は捨てました。デフォルトの場合はSphinx 1.6で破棄するという警告を発する.ユーザは環境変数PYTHONWARNINGSを設定することで行動を変更することができる.ご参照ください 警告のご利用はおすすめしておりません それがそうです。
#2454:新しいJavaScript変数
SOURCELINK_SUFFIX
追加されました
捨てて使う.¶
Sphinx-1.6ではこれらの機能が削除されている:
I 18 N機能ではLDML形式をサポート
sphinx.addnodes.termsep
Some functions and classes in
sphinx.util.pycompat
:zip_longest
,product
,all
,any
,next
,open
,class_types
,base_exception
,relpath
,StringIO
,BytesIO
. Please use the standard library version instead;
使用を推奨しない警告があれば RemovedInSphinxXXXWarning
表示されていますので、ご参照ください 警告のご利用はおすすめしておりません それがそうです。
追加された機能¶
1.5a1
#2951:追加
--implicit-namespaces
PEP-0420はapidocまで支援する.増列する.
:caption:
Sphinx.ext.inheritance(継承)図のためのオプション。#2471:デフォルトdoctestフラグに構成変数を追加します。
LinkCheckビルダを要求に変換して、より良い符号化処理を実現する
#2463,#2516:“META”コマンドのキーワードを検索インデックスに追加する
:maxdepth:
Toctreeオプションは影響を与えますsecnumdepth
(番号:#2547)#2575:今
sphinx.ext.graphviz
許す:align:
選択権.未知の鍵を指定すると
latex_elements
一致するドメインがない場合は、警告が表示されます
primary_domain
(番号:#2001)C++は、ロール·タイプが参照されるターゲット·タイプに対して誤った導電性を有する場合に警告(例えば、使用)を表示する
class
機能的役割)。LaTeXは、編集者がより多くのテキストスタイルをカスタマイズ可能なマクロ、例えばカスタマイズ可能なマクロに抽象化する
visit_emphasis
出力する.\sphinxstyleemphasis
ではなく\emph
(他の場所で使用される場合があり、または添加されたラテックスパッケージで使用される場合がある)。末尾のリストを参照してくださいsphinx.sty
(番号:#2686)LaTeXは、備考、警告、および他の警告タイプによって使用される環境およびパラメータの共通名であり、スレーブを許可する
'preamble'
キーまたは入力ファイル(参照:機能要求#2674,#2685)LaTeXは、いくつかのテーブルの列幅をよりよく計算する(したがって、行幅が正しく充填されているときにいくつかの微細な変化がある;参照:#2708参照)。
LaTeX,sphinxVerbatim環境の方がカスタマイズが容易である(参照:#2704参照)。VerbatimColorとVerbatimBorderColorを除いて:
two lengths
\sphinxverbatimsep
and\sphinxverbatimborder
,ブル人.
\ifsphinxverbatimwithframe
そして\ifsphinxverbatimwrapslines
それがそうです。
LaTeXは,テーブル内の文字ブロックのタイトルが処理され,長い符号行がテーブルセルに適応するように改行される(参照:#2704参照).
#2597:濃い赤色に警告メッセージを表示する
LaTeXでは、px単位の画像サイズ(デフォルト値は96 px=1インチ)を使用することができます。
無効なサイズ単位が発見された場合は、警告が表示されます
#2650:追加
--pdb
Setup.pyコマンドのオプションラテックス、ラテックスを利用する
\small
カスタマイズ可能なコードリスト(参照番号2721)#2663:追加
--warning-is-error
Setup.pyコマンドのオプション使用が推奨されていないLaTeXオプションを使用する場合は、警告が表示されます
Sphinx.configg.ENUMを追加して、候補に構成値が存在するかどうかをチェックします。
数学:HTML出力中の各式にハイパーリンクタグを付加する.
新しいテーマを追加する
nonav
これにはいかなるナビゲーションリンクも含まれていない.これはqthelpのようなヘルプ生成器に適用される。#2680:
sphinx.ext.todo
現在,以下のような場合があれば警告を発する.todo_emit_warnings
起動します。さらにこれは名前を出すことになりますtodo-defined
サードパーティ拡張におけるTODOエントリを処理する.Pythonドメイン署名解析器は現在,xrefを“異常”に混合し,異常クラスの自動リンクを許可している.
#2513:追加
latex_engine
Conf.pyでLaTeXエンジンを切り替える#2682:C++、基本サポート属性(C++11スタイルおよびGNUスタイル)。新しい構成変数‘cpp_id_tributes’および‘cpp_paren_tributes’は、カスタム属性を導入するために使用することができます。
#1958:C++、構成変数‘CPP_INDEX_COMMON_PREFIX’を追加して、C++オブジェクトのインデックステキストからプレフィックスを削除します。
C++は,概念命令を追加した.Mickk-on-CPPのおかげです
C++は,テンプレートへの文法導入の支援を加えている.Mickk-on-CPPのおかげです
#2725:LaTeX Builder:カスタムテンプレートファイルの使用を許可(実験的)
Apidocは現在,内容が変わらないファイルを書き込まないことで,キャッシュされたファイルを無効にすることを回避している.Apidocがつねに実行されていれば,これは顕著な性能優位をもたらす可能性がある.
#2851:
sphinx.ext.math
式が見つからなければ,引用不足のイベントを出す#1210:
eqref
役割はクロス引用をサポートしています#2892: Added
-a
(--append-syspath
) option tosphinx-apidoc
#1604:EPUB 3生成器:iBooksで表示したときにフォントに関連するCSSに準拠します。
#646:
option
指令は‘を支持する.文字を選択肢の一部とする家族愛に関する文書を付加し,文書構造を固定する.
#2474:追加
intersphinx_timeout
選択権.sphinx.ext.intersphinx
#2926:EPUB 3生成器は垂直モードをサポート (
epub3_writing_mode
オプション)#2695:
build_sphinx
Setuptoolsのサブコマンドが例外を処理する方法とsphinx-build
Vbl.作る#326:
numref
キャラクターは部分を参考にすることもできます#2916:
numref
キャラクタはタイトルをそのリンクテキストとして引用することも可能である.
1.5a2
#3008:
linkcheck
ビルダは自己署名証明書URLを無視する.#3020:新しい
'geometry'
重要なのはlatex_elements
LaTeXスタイルファイルのデフォルト使用geometry.sty
ページレイアウトを設定する手順#2843:start-at:および:end-at:テキストにオプションを追加するコマンド
#2527:追加
:reversed:
Toctree命令のオプション増列する.
-t
そして-d
選択権.sphinx-quickstart
テンプレート生成を支援するライオンの顔画像項目.#3028:追加
{{path}}
そして{{basename}}
以下の形式に変換するfigure_language_filename
新機能
'hyperref'
キー入力.latex_elements
辞書(番号3030)#3022:LaTeX PDF出力の脚注にコードブロックが含まれていることを可能にする
1.5b1
#2513:XeLaTeXのより良いデフォルト設定
#3096:
'maxlistdepth'
ラテックスリストの制限を解決する鍵#3060:autocはEnumクラスの属性ドキュメントをサポートします。現在,autocはEnum属性表現ではなくEnum属性の値のみを示している.
増列する.
--extensions
至るsphinx-quickstart
コマンドラインからの任意の拡張をサポート(参照:#2904)#3104、#3122:
'sphinxsetup'
FOR KEY=Sphinx LaTeXの値パターン#3071:Autodoc:アナログモジュール装飾器が関数をそのまま転送することを可能にする
#2495:linkcheck:スキップアンカーチェックの使用許可
linkcheck_anchors_ignore
#3083:Unicodeを切れ目なくスペースをLaTeXのように表現する
~
(修正#3019)#3116:PDF出力で行内文字の自動改行が許可されています(#3110参照)
#930:spinx-apidocは、ワイルドカードを使用してパスを排除することを許可します。ニック·コグレンのおかげです
#3121:追加
inlineliteralwraps
LaTeXにおける文字改行の有無を制御するオプション
1.5決勝戦
#3095:追加
tls_verify
そしてtls_cacerts
LinkcheckおよびIntersphinxでは自己署名HTTPSサーバをサポートする#2215:Shinx-QuickStartによって生成されたmake.batを別のディレクトリから呼び出すことができます。ティモテウス·カンピックのおかげです
#3185:新しい警告タイプの追加
misc.highlighting_failure
誤りを修正する¶
1.5a1
#2707:(LaTeX)テーブルの列幅計算エラー
#2799:Sphinxは、Sphinxモジュールを導入する際に、ロールおよびコマンドを自動的にインストールします。現在,Sphinxはそれらを実行中のアプリケーションに実装している.
sphinx.ext.autodoc
ターゲットコードが以下のようにシミュレーションモジュールから導入されていれば,クラッシュする.autodoc_mock_imports
それがそうです。#1953:
Sphinx.add_node
変換器のインストールを追加しない処理プログラムhtml_translator_class
#1797:テキスト生成器は、上部に空き行を挿入します。
#2894:QuickStart main()argvパラメータを使用しない
#2874:gettext生成器が抽出できません
only
指令#2485:複数のSOURCE_SUBFIX値を有する自動集約崩壊
#1734:toctreeコマンドを翻訳できないタイトル
メタコマンドの内容を変換できない(参照:#1734)
#2550:ヘルプビューアで外部リンクを開く
#2687:Sphinxを複数回実行すると“登録済み”警告が生成されます。
1.5a2
#2810:イタリア文書のpdflatexの問題
使用
latex_elements.papersize
Makefileでラテックスの紙サイズを指定する#2988:リンクチェック:Head要求が拒否された場合、GET要求を使用して再試行する
#2990:Linkcheck_Anchorsが有効になった場合、Linkcheckは“”bytes“オブジェクトを暗黙的文字列に変換できない”エラーを誘発します。
#3004:使用されているリンクタイプ“top”および“up”は無効です。
#3009:LaTeXで解析された文字は、Sphinx 1.4.4以来、エラーを示しています。
#3000:
option
コマンドは無効なHTMLアンカを生成する.#2984:以下の条件を満たす場合、無効なHTMLを生成する
html_split_index
有効にする#2986:Themes/Basic/findex.htmlをHTML 5に変更する必要があります。
#2987:1つのリストに複数のIDが割り当てられると、無効なHTMLが生成される
#2891:HTML検索ではすべての結果を提供できません
#1986:PDF出力のタイトル
#147:ラテックス章スタイルの問題
#3018:ページレイアウトサイズとセクションタイトルのラテックスの問題
修復問題を使う
\pysigline
LaTeXスタイルファイル(番号3023)#3038:
sphinx.ext.math*
ラベルが重複しているとTypeErrorを引き起こす#3031:LaTeXパッケージと互換性がない
tocloft
#3003:Latexは脚注の文字ブロックをサポートしていません
#3047:pdf出力における脚注前のスペースの一貫性がなく、改行が許可されています。
#3045:htmlである場合、HTML検索インデックス作成者は、“元の”コンテンツを無視すべきである
#3039:単語が大きく書かれている場合、英語語幹解析器は誤った単語を返す
修復作成モードMakefileテンプレート(参照番号3056,#2936)
1.5b1
#2432:varargsとキーワードパラメータのみの間で不要な*を修復します。アレックス·グレンホルムのおかげです
#3062:1.5 a 2を使用してPDFを構築することができません(未定義
\hypersetup
PR#3030以降の日本語文書に適用)Htmlでは、複数行の署名がより良く提示される。
#777:ラテックス出力“入れ子が深すぎる”(参照番号3096)
ラテックスのイメージを服従させる
scale
テキスト幅適合前(参照番号2865,#3059)#3019:LaTeXはパラメータ付きC関数を記述する際に失敗した(#3083参照)
Laex内接文字を以下の位置で修復する
< > -
がつがつと場所を占領した
1.5決勝戦
#3069:たとえ
'babel'
キーは空文字列に設定され、LaTeX出力は1つを含む\addto\captions...
#3123:ユーザ
'babel'
鍵の設定を守らなくなりました#3155:次のオブジェクトを修復するJavaScript
html_sourcelink_suffix
IEとOpera失敗#3085:構築ドキュメントを破壊した後、現在のディレクトリを保持します。ティモテウス·カンピックのおかげです
#3181:Platexが崩壊し、部分に尾線線が含まれている
#3180:LaTeX:連続する単行または複数行のCPP署名間に引張/収縮を追加する(#3072参照)
#3128:グローバル画像では.svgzファイルがサポートされていません。
#3015:Windows上で失敗したテストを修復します。
#1843:カスタム要素クラスを有するディスクリプタクラスを修復するドキュメント。エリック·ブラウンのおかげです
#3190:utill.plit_docinfoは多行フィールド体を解析できません。
#3024,#3037:Python 3では、当日志メッセージをコンソールとして符号化できない場合、Applation.Sphinx._logが崩壊します。
テストをする¶
簡略化のため,unittest.mockが存在してもShinxは外部アナログパケットを用いる.
バージョン1.4.9(2016年11月23日リリース)¶
誤りを修正する¶
#2936:ドキュメント/MANの存在によりMANを構築できないドキュメント/Makefileの修復
#3058:複数の‘toctree’コマンドで同じ‘caption’属性を使用すると警告/エラーになります。
#3068:sphinx-build.pyの-Dオプションで‘=’文字を使用することを許可します。
#3074:
add_source_parser()
デバッグモードで崩壊する#3135:
sphinx.ext.autodoc
通常のCallable崩壊を使って#3150:JavaScriptのクエリ·タブを修復します。その振舞いはPythonの正規表現と同じである.
#3093:置換イメージ上のgettext構築が破損しています。
#3093:次のイメージノード上のgettext構築が破損しています。
note
指令する。Imgath:画像生成に失敗すると,エラーメッセージを表示する際にクラッシュする.
#3117:第1の部分タイトルの前に置くことを戒めたら、Laex Writerは崩壊する
#3164:検索順序の変更
sphinx.ext.inheritance_diagram
バージョン1.4.7(2016年10月1日リリース)¶
誤りを修正する¶
#2890:QuickStartは、すべてのエラー条件で一致してエラーを返す必要があります。
#2870:genindex列の高さを平らにします。
#2856:生成されたHTMLサイトでいくつかの記号が見つからないことを検索する
#2882:リンクチェックで403状態に戻るGET要求
#2902:キーワードが以下の下線で始まる場合、jsdump.loadsは検索インデックスをロードできません。
#2900:epub content.opfの修復:自動的に生成された孤立ファイルを脊柱に追加します。
#2899: Fix
hasdoc()
function in Jinja2 template. It will detectgenindex
,search
also.#2901:epubの修復結果:画像マークから元の画像ファイルへのリンクの作成をスキップします。
#2917:HTML上のイントラネットコードはハイフンで接続されています。
#1462:下線に続く属性を有する名前付きタプルに警告を自動的にまとめる
以下のような場合があれば,式を引用することはできない
:nowrap:
オプションを指定しました#2873:LaTeXのコードブロックオーバーフロー(コンマによる)
#1060,#2056:sphinx.ext.intersphinx:ある場合
intersphinx_mapping
#2931:SAME:CAPTION:を有するコードブロック命令は、重複ターゲットの警告をもたらす。今
code-block
そしてliteralinclude
ヘッダを用いてハイパーリンク先を自動的に定義することはない.#2962:LaTeX:長いテーブルラベルの欠落
#2968:autodoc:show-heritanceオプション中断文書文字列
バージョン1.4.6(2016年8月20日リリース)¶
互換性のない変更¶
#2867:Linkcheck BuilderおよびSix-1.4が崩壊します。現在のライオンのイメージは6-1.5以上に依存しています
誤りを修正する¶
Applehelp:次のような場合、Sphinxは崩壊します
hiutil
あるいは…。codesign
命令が見つからない手入れをする.
make clean
構築ディレクトリに通常のファイルが含まれている場合(例えば、DS_Store
それがそうです。Epubcheck警告/エラーを減らす:
DOCTYPEをHTML 5に修復
拡張子を.htmlから.xhtmlに変更します。
Epub結果の検索ページを無効にする
#2778:autocクラッシュの修復 obj.__dict__ 属性方法で異常を起こしています
EPUB 3出力で重複するTOCを修復する.
#2775:IDコードをサポートしていないサーバとのリンクチェックに失敗しました。
#2833:ext.autocのフォーマットされたインスタンスの書き込みを修復します。
#1911:
-D
オプションsphinx-build
書き直すことができないextensions
変数.変数#2789:
sphinx.ext.intersphinx
在庫が与えられた場合,誤ったハイパーリンクが生成される.文書にはコードブロックヘッダの解析誤りが表示されている(番号:#2845).
#2846:
singlehtml
構造器には地物番号は含まれていません#2816:構築された混乱を修復するデータ
Domain.initial_data
類属性.
バージョン1.4.5(2016年7月13日リリース)¶
互換性のない変更¶
LaTeXでは、image命令から含まれる非インターフェイス画像は、元の画像の幅に依存して不連続な空白をもたらし、場合によっては、新しい行為は必然的に以前の動作とは異なる。(番号:#2672)
ラテックス、使用
\includegraphics
Sphinxカスタム変数を参照することは放棄されている;将来的には元のLaTeXマクロに復元され、カスタム変数はすでに代替名を持っている。\sphinxincludegraphics
それがそうです。
追加された機能¶
新しい構成オプション
latex_keep_old_macro_names
デフォルトはTrueである.Falseであれば,マクロ(テキストパターン用)の定義のみを許す.\sphinx
-プレフィックス名LaTeX Writerは、ユーザが3つの長さ変数によって“シャドウ”ボックス(トピック)をカスタマイズすることを可能にする。
Epub生成器は現在woff形式のWebフォントファイルをサポートしている.
誤りを修正する¶
Python 3のjsdump修復:python>3上のHTML検索を修復します。
#2676:(LaTeX)Sphinx 1.4.4から字幕の逐語テキストエラーを開始します。
#2629:思い出録崩壊ラテックス。修復者.
latex_keep_old_macro_names=False
(参考文献2675)#2684:
sphinx.ext.intersphinx
Six-1.4.1で墜落しました#2679:
float
以下の項目に必要なパッケージ'figure_align': 'H'
LaTeXオプション#2671:imageコマンドによりpdfの間隔が一致しない場合があります。
#2705:
toctree
以下の場合があれば,空のBullet_Listを生成する.:titlesonly:
指定#2479:
sphinx.ext.viewcode
デフォルトでpython 2蛍光ペンを使用#2700:HtmlHelp生成器ハードコードindex.html
Laex,1.4.4行内の文字テキストの直後に偽のスペースがついているから
#2722:C++は、名前空間を含むようにvar/メンバ宣言のid生成を修復します。
LaTeX、リスト、または引用符ブロック内の画像(画像命令から)は、インデントに適合しない(#2671と共に修復)
#2733:スフィンクス-1.4.4以来
make latexpdf
大量の超引用警告を生成する#2731:
sphinx.ext.autodoc
異常を引き起こす属性にアクセスしない方法#2666:C++、構造関数に関する入れ子名を正しく検索します。
#2579:スペースとコロンを同時に含むラベルを参照することができません
sphinx.ext.intersphinx
#2718:文書ファイルが読めない場合、Sphinxが崩壊します。
#2699:HTMLsを支援するハイパーリンクが切断される場合
html_file_suffix
設置されました#2723:複数行のセルから出力されたLaTeX pdfに余分なスペースが存在します。
#2735:latexpdf
Underfull \hbox (badness 10000)
バナーページからの警告#2667:サイズ調整された画像が部分タイトルに表示された場合、LaTeXは崩壊する
#2763:(HTML)Requiredのデフォルト値を提供します。
alt
SVGソース画像タグの属性は,検証が必要であり,現在は他のフォーマットと一致している.
バージョン1.4.4(2016年6月12日リリース)¶
誤りを修正する¶
#2630:LaTeX:sphinx.sted環境フォーマットの問題を通知する
#2632:オファー環境LaTeX構築に失敗した警告指示
#2633:Sphinx古いスタイルのインデックスを使用してクラッシュ
1つ修復する
\begin{{\minipage}}
1.4.2から,sphinx.stedにおける打鍵ミス(参照:68 becb 1)#2622:LaTeXは、タイトルおよびディレクトリの後に空ページを生成します。
#2640:1.4.2コードブロックがWARNING命令内にある場合、LaTeXは崩壊する
LaTeXにもインラインコードに直接引用符(番号2627)を使用させる.
#2351:エニュメレート·リストが脚注に配置されている場合、LaTeXは崩壊する
#2646:数学に2つの空行が含まれている場合、LaTeXは崩壊する
#2480:
sphinx.ext.autodoc
:メモリアドレスが表示されていますLaTeX:コードブロックが最大入れ子深さでリストおよび引用符内に現れることを可能にする(参照番号#777、#2624、#2651)
#2635:LaTeXコード命令は、視聴解像度に応じて不一致フレームを生成する
#2639:ライオンの顔像iftex.stedがバンドルされています
Framed.ty 0.95でPDFを構築することはできません
ライオンの顔像は今針空間を縛っています。
バージョン1.4.3(2016年6月5日リリース)¶
誤りを修正する¶
#2530:警告に大きな番号の脚注が存在する場合、PDF生成時に“カウンタが大きすぎる”エラーが発生します。
width
以下の場合、Figureコマンドのオプションは機能しないalign
同時指定オプション(番号:#2595)#2590:
inputenc
Lualatexとxelatexでの翻訳パッケージ中断#2540:LaTeXのトップページの日付に異なるフォントが使用されています。
文書が含まれている場合は,“Document is not included in any totree”(文書はどのディレクトリ木にも含まれていない)警告の表示は禁止される(参照番号:#2603).
#2614:ユーザがプリアンブルに非ゼロparindentを設定した場合、PDF出力のいくつかのテーブルがシフトします。
#2602:URLリダイレクト中断生成されたハイパーリンク
sphinx.ext.intersphinx
#2613:マージの拡張がロードされた場合、警告が表示されます。
#2619:amstextラテックスパッケージが常にロードされていることを確認します(参照:d 657225、488 ee 52、9 d 82 cad、および#2615)
#2593:表に何かの数字があれば、LaTeXは崩壊します。
バージョン1.4.2(2016年5月29日リリース)¶
追加された機能¶
今
suppress_warnings
以下の構成を受け付けます(参照番号:#2451、#2466):app.add_node
app.add_directive
app.add_role
app.add_generic_role
app.add_source_parser
image.data_uri
image.nonlocal_uri
#2453:LaTeX Writerは、トピックコンテンツ内のページ分割を可能にし、それらの水平範囲は、行幅(エッジ距離が陰影を有する)に適している。さらに、警告型警告は、その垂直間隔がプロンプト通知(Ref#2446)よりも一致したページを分割することを可能にする。
#2459:LaTeX出力内の文字コードブロック(コード行自体だけではない)のフレームワークは、リストまたは引用ブロック内のインデントに従う。
#2343:コードブロック内の長いソースコードラインは、LaTeX出力にパッケージされている(行番号を修正しない)(REF#1534、#2304)。
誤りを修正する¶
#2370:LaTeX Writerの方程式が少しずれている
#1817、#2077:sphinx-ickstartによって生成されたconf.py上のPep 8警告を抑制する
#2407:ドキュメントにビッグデータ画像URIが含まれている場合、ドキュメントクラッシュを構築します。
#2436:Sphinxは、以下のようにバージョンをチェックしません。
needs_sphinx
拡張モジュールのロードに失敗した場合#2397:トルコ語文書の略語の設定
#2447:VerbatimBorderColor PDFタイトルにも誤って使用されています
#2456:C++、ドキュメント統合に関連するクラッシュ(例えば、singlehtmlおよびLatexビルダ)を修復します。
#2446:LaTeX(Pdf)堅牢なボックスにローカルディレクトリ(またはより一般的なトピックノード)を設定し、ボトムオーバーフローを引き起こす
#2476:与えられた場合:nowrap:であれば、MathJaxフラグは省略されます。
#2465:toctree命令にタイトルオプションを提供していない場合、Laex生成器は失敗する
Toctreeから引用するとSphinxは崩壊します
#2481:mecabチェッカのスペルエラーを検索します。佐藤直樹のおかげです。
#2309:修復プログラムは、ロールを参照することによって“間接ハイパーリンク先”を参照することができません。
マッピングURLに任意のポートが含まれている場合、Intersphinxは失敗します。
#2088:URLをマッピングするために基本的な認証が必要な場合、Intersphinxは崩壊します。
#2304:latexpdfコードブロックの自動改行
#1534:Latexのプログレッシブ記録ブロックの長い行の改行
#2460:PDF出力におけるタイトル文字ブロック上部の空白が多すぎます
複数の数学的拡張をロードした場合にエラー原因を表示する(参照:#2499)
#2483:グラフィックタイトルに非テキストオブジェクトのみが含まれている場合、グラフィック番号は割り当てられていません。
#2501:LaTeXでUnicodeの添字を正規化する
#2492:Figureコマンドと:FigWidth:誤ったLatexコードを生成する
図形のタイトルは常に中心に置かれています
:align:
指定された#2526:セグメントが画像のみを含む場合、Laex Writerは崩壊する
#2522:Sphinxがインストールディレクトリのmoファイルに触れると、権限エラーが発生します。
#2536:C++,即時入れ子のスコープが現在のスコープと同名である場合に発生する崩壊を修復する.
#2555:Unicodeを使用して参照のクラッシュを修復します。
#2517:LuaLaTeXを使用した場合のPDFのブックマーク符号化エラー
#2521:sphinx-buildが見つからない場合、生成されたMakefileはBSD makeを崩壊させます。
#2470:
typing
バックポートパッケージによりPython 2.7の自動ドッキングエラーが発生sphinx.ext.intersphinx
crashes if non-string value is used for key ofintersphinx_mapping
#2518:
intersphinx_mapping
非英数字キーのご使用は禁止されております#2558:devhelpジェネレータでのパケット解除エラー
#2561:脚注にリンクが含まれている場合、情報生成器が崩壊する
#2565:生成されたオブジェクト記述
sphinx.ext.autosummary
ラテックスライタ上のオーバーフロー線Sphinx.stedにおけるpdflatex構成をセグメントに拡張する(参照番号:#2551)
#2445:
rst_prolog
そしてrst_epilog
非休憩源への影響#2576:
sphinx.ext.imgmath
子プロセスが誤りを起こしたら崩壊する.#2577:
sphinx.ext.imgmath
:dvisvgmに無効パラメータを渡す#2556:Xapian検索はPython 3には適用されません。
#2581:language=“es”(スペイン語)の場合、検索が機能しません。
#2382:LaTeX Writerでの数字の略語の間隔を調整する
#2383:以下の者により生成された脚注
latex_show_urls
あふれ出線.#2497、#2552:検索ボタンのラベルはボタン自体に適していません。
バージョン1.4.1(2016年4月12日リリース)¶
互換性のない変更¶
デフォルトフォーマットは
today_fmt
そしてhtml_last_updated_fmt
再びstrftime形式に戻ります。Sphinx-1.5までは,後方互換性のために,領域設定日付マークアップ言語もサポートされている.
訳文¶
ジェレント·パーマーのおかげでウェールズ語の翻訳が増えました
Stelios Vitalisのおかげでギリシャ語翻訳が増加した。
ディヌ·ゲルマンのおかげでエスペラント翻訳が増えた。
ヒンディー語翻訳が増加したのはPurnank H.Ghumaliaのおかげだ。
ラズワン·ステファン·ネスクーの助けにより、ルーマニア語の翻訳が増加した。
誤りを修正する¶
C++、ペアを追加しました
extern
そしてthread_local
それがそうです。C++, type declarations are now using the prefixes
typedef
,using
, andtype
, depending on the style of declaration.#2413:C++、重複宣言の崩壊を修復
#2394:html_last_update_fmtが無効な場合、Sphinxが崩壊します。
#2408:Makefileおよびmake.batでは仮想生成器が利用できません
#2412:LaTeX生成器のハイパーリンク先が切断されました
非段落項を見出しとして提供すると、Figure指令が崩壊する
#2418:TODAY_FMTでは時間フォーマットが許可されていません
#2395:画像ファイル名にUnicode文字が含まれている場合、Sphinxは崩壊します。
#2396:genindex-Singleの“パッケージ解除する値が多すぎる”
#2405:PDFのnumrefリンクがエラー位置にジャンプ
#2414:コードリストへのPDFハイパーリンクに数字が欠落している
#2440:gmtimeの読み込みエラーです。ウヴェ·L·コーエンのおかげです
バージョン1.4(2016年3月28日リリース)¶
互換性のない変更¶
落ちる.
PorterStemmer
バッグがサポートしています。使用PyStemmer
ではなくPorterStemmer
茎の成長を加速させることができますSphinx_RTD_THEMEはオプションになっている。手動でインストールしてください。文献#2087、#2086、#1845、#2097を参照されたい。ビクター·ズベロビッチのおかげです
#2231:LaTeXコンパイラのカスタムロールには、DUspanではなくDURoleを使用します。これは,キャラクタの肩書を自己定義マクロのパラメータとすることを可能にする.
#2022:‘Thumbs.db’および‘.DS_Store’を追加する
exclude_patterns
Sphinx-QuickStartで提供されるconf.pyのデフォルト値になります。#2027、#2208:
html_title
文字列の値のみを受け取る.また,None値は受け入れられない.sphinx.ext.graphviz
:デフォルトでグラフィックス画像をインターコネクトで表示する#2060,#2224:
manpage
役割は現在生成されていますsphinx.addnodes.manpage
ノードではなくsphinx.addnodes.literal_emphasis
ノードです。#2022:
html_extra_path
追加ディレクトリのポイントファイルもコピーして参照しますexclude_patterns
追加のファイルやディレクトリを排除するには、以下の操作を実行してください。#2300:AutoClassを強化:使用するドキュメント文字列 __new__ もし __init__ メソッド%sが欠落しているか、または空であるか
#2251:以前、語彙表命令の下で、1つの定義された複数のタームが単一のタームに変換された
term
ノードとタームノードの各タームの間で使用されるtermsep
ノードです。新しい実装では、各用語は別個のものに変換されるterm
ノードとtermsep
ノードは削除される.この変更により,ビルダごとに出力レイアウトが少し変更される.デフォルトの強調表示言語は現在Python 3です。これは,ソースコードがPython 3(主にPython 2のスーパーセット)として強調表示されており,解析によって有効なコードを区別しようとしないことを意味する.元の行動に戻るには、追加してください
highlight_language = "python"
Conf.pyへ。Locale Date Markup Language 像
"MMMM dd, YYYY"
はい、デフォルトフォーマットです。today_fmt
そしてhtml_last_updated_fmt
それがそうです。ただし,strftimeフォーマットは以下のとおりである"%B %d, %Y"
Sphinx-1.5の前に、後方互換性もサポートされている。後のフォーマットはSphinx-1.5から無効になります。#2327:
latex_use_parts
今は捨てられています。使用latex_toplevel_sectioning
代わりに。#2337:使用
\url{{URL}}
マクロではなく\href{{URL}}{{URL}}
“ラテックス作家”にあります#1498:マニュアルページライタ:定義リストに強いノードが含まれている場合、項目全体を太字に設定しないでください。
#582:html出力の高速検索ボックスからプロンプトメッセージを削除します。
#2378:ライオンの顔像newflat.styを束ねています
追加された機能¶
#2092:ナポレオンパッケージにTODOコマンドサポートを追加します。
#1962:拡張追加命令、ロール、またはノードから、そのような要素がすでに存在する場合(内蔵されているか、または別の拡張によって追加されている場合)、警告が発行される。
#1909:Intersphinx在庫に対する“doc”参照を追加します。
C++タイプ別名サポート(例えば、
.. type:: T = int
)。クラス、関数、タイプ別名、および変数のC++テンプレートサポート(#1729、#1314)。
C++は,新たなスコープ管理コマンドを追加した.
namespace-push
そしてnamespace-pop
それがそうです。#1970:次のトピックと前のトピックをナビゲートするキーボードショートカットキー
Intersphinx:HTTP Basic認証を用いたURLからIntersphinxリストを取得する支援を追加した.
C++は、関数情報フィールドリスト内のテンプレートパラメータのサポートを追加します。
C++は,メンバ(関数)へのポインタの支援を加えている.
#2113:許可
:class:
コードブロック命令のオプション。#2192:imgath(SVGのpngathをサポート)。
#2200:Laex BuilderはXeTeXとLuaTeXをサポートします。
#1906:ラテックス出力のために使用可能なfColorboxでは、colorではなくxcolorを使用します。
#2216:テクスチャ入力Makefileの改善。
#2170:中国語検索インデックスがサポートされています。
#2214:GitHubページへのsphinx.ext.githubagesのパブリッシュ
#1030:latex_show_pagerefsのページ参照名を翻訳可能にする
#2162:Sphinx.add_source_parser()を追加し、拡張からsource_suffixとsource_parserを追加します。
#2207:sphinx.parsers.Parserクラスの追加;新しいパーサの基本クラス
#656:追加
graphviz_dot
選択肢を切り替えるdot
命令する.#1939:追加されました
dummy
Builder:文法検査,出力しない.#2230:追加
math_number_all
数学拡張に表示されたすべての数学を番号付けするオプション#2235:
needs_sphinx
微版比をサポート#2282:基本トピックのhtmlタグにlanguageプロパティを追加する
#1779:EPUB 3生成器の追加
#1751:追加
todo_link_only
ファイルパスや行指示を開くことを避けるためには、以下の操作を実行してくださいtodolist
それがそうです。フランシスコ·モンテサノのおかげです#2199:使用
imagesize
画像サイズを取得するためのパケット。#1099:構成可能再試行をリンクチェック生成器に追加します。アレックス·ガイナのおかげですまた、検査しないでください
!
それがそうです。#2300:AutoClassを強化:使用するドキュメント文字列 __new__ もし __init__ メソッド%sが欠落しているか、または空であるか
#1858:Sphinx.add_ENUMERABLE_NODE()を追加し、numfig機能に列挙可能ノードを追加します。
#1286、#2099:追加
sphinx.ext.autosectionlabel
参照部分がそのタイトルを使用することを可能にするように拡張される。Tadhg O‘Higginsのおかげで#1854:日本式分割器としてJanomeを選択することができます。
#1853:html検索でのカスタムテキスト分解器の使用をサポート
language='ja'
それがそうです。#2320:語彙テーブル用語の分類器は、翻訳のために使用されてもよいインデックスエントリグループ化キーワードのために使用されてもよい。また見られる. 用語表 それがそうです。
#2308:定義
\tablecontinued
マクロは長いテーブルの連続ラベルのパターンを再定義する.複数の画像が以下のようにボール化されていれば,類似度に応じて画像を選択する.
.. image:: filename.*
#1921:デジタル置換をサポート
language
そしてfigure_language_filename
#2245:追加
latex_elements["passoptionstopackages"]
はじめの早い段階でPassOptionsToPackagesのオプションを呼び出す.#2340:数学的拡張:MathJaxの複数の式の整列をサポートします。
#2338:定義
\titleref
そのスタイルのマクロを再定義するtitle-reference
役。定義
\menuselection
そして\accelerator
そのスタイルのマクロを再定義するmenuselection
役。定義
\crossref
参照パターンを再定義するためのマクロ#2301:古典的htmlトピックのテキストはハイフンで接続されるべきです。
#2355:定義
\termref
そのスタイルのマクロを再定義するterm
役。増列する.
suppress_warnings
任意の警告メッセージの表示を禁止する(実験的)#2229:未知のオプションを修復するには警告を出さない
#2327:追加
latex_toplevel_sectioning
LaTeX文書のトップスライスを切り替えるには,以下の操作を実行してください.
誤りを修正する¶
#1913:C++、サブグローバルおよびグローバル範囲内の枚挙器のアサート誤りが修復されました。
C++は,“Signed char”と“unsign char”をタイプに解析する問題を修復した.
C++では,“Friend”関数の欠落サポートが追加されている.
C++は,仮想基底クラスの欠落支援を追加した(これはRapptzのおかげである).
C++は,最終クラスへのサポートを追加した.
C++は,接頭辞が‘enum’であるタイプの解析を修復した.
#2023:オランダ語検索は、デンマーク語語幹情報の使用をサポートします。
C++では,ユーザ定義文字への支援が付加されている.
#1804:htmlは、サイドバーでオーバーフローされた長い行テキストをパッケージに出力します。ハーソン·ビン·タンバースのおかげです
#2183:ポート乾燥機の修復理由
make json
失敗する。#1899:OptParseにリストが送信されたことを確認します。
#2164:sphinx.sted内のpdftexのエラーチェック(Graphicxパッケージオプションのため)が修復されました。
#2165,#2218:欠陥および不要な条件をsphinx.styから削除します。
修復未知言語が与えられると,壊れたLaTeXコードが生成される.
#1944:rst_prolog割込みファイル範囲のメタデータを修復する
#2074:make gettextは、.potに対して仕様の相対パスを使用する必要があります。アナトリー·テコトニックのおかげです。
#2311:sphinx.ext.Inheritative_WATRAGE AttributeErrorの修復
#2251:.rstファイルの変換子は、エラーで.potファイルに転送されます。
#794:LaTeX出力の固定日フォーマットがネイティブ化されていない
除去
image/gif
LaTeXコンパイラからのSUPPORTED_IMAGE_TYPE(#2272)Languageが空文字列であれば,Fix ValueErrorを引き起こす.
生成されたコマンドに修復解パケット警告が発生する.
Sphinx.add_crossref_type
vt.使用デフォルト強調表示言語は現在
default
それがそうです。これは、可能であれば、ソースコードがPython 3(主にPython 2のスーパーセット)として強調表示されることを意味します。元の行動に戻るには、追加してくださいhighlight_language = "python"
Conf.pyへ。#2329:ソースディレクトリが変更された場合、環境を強制的にリフレッシュします。
#2331:リペアコード-DVIのブロックがブロックで充填され、削除される
xcdraw
Xcolorパッケージのオプション修復Unicodeに文字列値を必要とする配置を与えると,配置タイプチェッカが警告する.
#2360:LaTeX出力でFIX Numrefが破損
#2361:FIX“複合”コマンド内の他のパラグラフのインデント
#2364:古いバージョンからSphinxがアップグレードされたときに発生したKeyError‘rootSymbol’を修復します。
#2348:Laex Writerがamsathおよびamssymbをfontpkgに移動する前に。
#2368:emacsロックファイルを無視します。
.#foo.rst
デフォルトの場合。#2262:LaTeX出力では、text_blockおよびそのヘッダは、ページ分割で分離されている。
#2319:LaTeXのコードブロックは、修復テーブルカウンタを上書きします。Jfbuのおかげです。
第三者ドメイン拡張と組み合わせて使用した場合のパケット解除警告を修復した.
#1153:サイドバーの数字を修復することにより、Laex構築エラーが発生します。
#2358:FIX User-Preamble TocDepth定義を上書きできません。
#2358:TocDepthの減少
part
あるいは…。chapter
Top_sectionlevel用#2351:脚注間隔の修復
#2363:修復
toctree()
テンプレートにSingleHTMLBuilderにおける切断リンクを生成する.#2366:HTML生成器におけるtoctree上で生成された空超参照を修復します。
書類¶
#1757:修復された使い方
html_last_updated_fmt
それがそうです。ラルフ·ヘメックのおかげです
バージョン1.3.6(2016年2月29日リリース)¶
追加された機能¶
#1873、#1876、#2278:追加
page_source_suffix
HTMLコンテキスト変数。これは以下のように紹介すべきであるsource_parsers
クローズアップする。ありがとうエリック·ホルシェール。
誤りを修正する¶
#2265:バベルタ機能の修復が有効になっているにもかかわらず、使用されています。
latex_elements
#2295:Python 3を使用した自動ドッキングでメンバを列挙する際の変異辞書エラーの発生を避ける
#2291:ディレクトリ内のpdflatex“カウンタが大きすぎる”エラーを修復します。
#2292:LaTeX出力から脚注が消失したいくつかの問題を修復する
#2287:
sphinx.transforms.Locale
最初の解析器を常に使用していますSphinx i 18 n特性は、source_parsersを指定するパーサをサポートすべきである。#2290:修復
sphinx.ext.mathbase
Amsfontsの使用はユーザーの数学フォントの選択を破壊する可能性があります#2324:再帰制限がヒットした場合、再帰的制限をどのように増加させるかのプロンプトを印刷します。
#1565,#2229:新しい警告を再開し、新しい警告はバージョン1.4からトリガされます。
#2329:ソースディレクトリが変更された場合、環境を強制的にリフレッシュします。
#2019:検索結果のドメインオブジェクトの変更を修復
バージョン1.3.5(2016年1月24日リリース)¶
誤りを修正する¶
LaTeXおよびTexinfoビルダの警告には修復行番号は表示されていない
修復ファイル名は引用警告に表示されていません
LaTeXおよびTexinfoビルダの警告には修復行番号は表示されていない
インデックス警告には固定行番号は表示されていません
#2026:解析文字にリンクが含まれている場合、LaTeXビルダの修復にエラーが発生します。
#2243:カテゴリの変な文書文字列タイプを無視し、崩れないように
#2247:修復#2205セパレータは、正規表現のような文字列を含む分類器を有する定義リストのためのhtmlを生成する
#1565: Sphinx will now emit a warning that highlighting was skipped if the syntax is incorrect for
code-block
,literalinclude
and so on.#2211:表セル中のパラグラフを修復することはLatex出力では機能しない
#2253:
:pyobject:
オプションliteralinclude
コマンドでは,スペースやコメント行で始まるインデント本体ブロックを検出することができない.FIX TOCが表示されていなければ,FIX TOCは表示されない.
:maxdepth:
ディレクトリツリー(参照番号:#771)に適用以下の項の警告メッセージを修復する.
:numref:
対象が孤立文書にある場合(番号:#2244)
バージョン1.3.4(2016年1月12日リリース)¶
誤りを修正する¶
#2134:参照修復イラストタイトルの使用によるLaTeX構築エラー
#2094:参照修復問題の使用はLatexでは機能しません
#2147:LaTeXの修復テキストには、ページ分割されないコードが含まれています。
#1833:latex_show_urlsがNONEでない場合、修復電子メールアドレスを再表示します。
#2176:sphinx.ext.raphviz:<img>の代わりに<object>を使用してSVGを埋め込む
#967:SVG引継グラフの修復ハイパーリンクがない(クリック可能)
#1237:LaTeXの定義リストで機能しない脚注を修復する
#2168:FIX RAWコマンドはテキストライタには適用されません
#2171:修復プログラムは、チェックURLをUnicodeにリンクできません。
#2182:LaTeX:1点以上の画像ファイル名をサポート
#2189:ルートディレクトリツリーからツリーへの前のファイルではなく、サブディレクトリの最初のファイルの上位の同レベルリンクを修正するために、最後のファイルを使用します。
#2003:python 2での復号エラーを修復(限定)
make linkcheck
運行#2186:数学の修復mathbbのLaTeX出力
#1480,#2188:LaTeX:章のタイトルで数学をサポート
#2071:2つ以上の章タイトルの同じ脚注=>LaTeX/PDF Bugを修復
#2040:著者が非ASCII文字を含む場合、sphinx-apidocのUnicodeDecodeErrorを修復
#2193:ソースディレクトリとターゲットディレクトリが同じである場合、Shutill.SameFileErrorを修復します。
#2178:修復使用:cpp:any引用関数の場合解析できないC++交差引用:
#2206:脚注のため、Sphinx LaTeXドキュメント構築に失敗しました。
#2201:30行を超えるフォームタイトルエラーを修復
#2213:古典的なトピックに<p>に適応するために<BLOBQUTE>を設定する
#1815:warniserrorがtrueに設定され、リンクが中断されている場合、修復リンクチェックに異常は発生しません。
#2197:index.rstファイルが欠落しているやや曖昧なエラーメッセージを修復する
#1894:クイックスタートMakefileに記載されていない偽のターゲット
#2125:統合折り畳みフィールドを修復する動作 (
GroupedField
そしてTypedField
)#1408:LATEX_LOGOの有効性の確認
#771:リペアラテックス出力は深さに設定されていません。
#1820:Windowsでは、Coloramaバージョン0.3.3ではコントロールカラーはサポートされていません。現在,ライオンの顔像はColorama>=0.3.5を用いてこの問題を回避している.
#2072:修復チャプタの脚注-タイトルはPDF出力には表示されません。
#1580:長い表の段落を修復することは、Latex出力では機能しません。
#1366:LaTeXの中心ではない中央画像の修復
#1860:修復マニュアルページの使用
:samp:
大きな括弧を使う-フォントはリセットされません#1610:いくつかのシステムの日本語インデックスのSphinx崩壊
Mabの修復初期化に失敗した場合、Sphinxが崩壊します。
#2160:一部に画像が含まれている場合、PDFの破損ディレクトリを修復します。
#2172:修復機能障害の警告
\py@lightbox
ライオンの顔像の中にあります。Jfbuのおかげです。#2198、#2205:
make gettext
定義リストのために破損したmsgidを生成する.#2062:Python 2 doctestの変換文字を正しく処理できません。
#2225:リペアオプションがブレーク番号で先頭でない場合、リンクは実行されません。
#2226:nowrap:が与えられたとき、修復数学がHTMLコードではない(jsath,mathjax)
#1601,#2220:‘Any’ロールは拡張ドメインアクションに違反します。影響を受けた拡張は、RESOLUE_ANY_xrefをサポートせず、RESOLVE_xrefは、無ではなく、問題のあるノードに戻る。Sphinxcontrib−httpdomainもその1つである。
#2229:未知のオプションを修復するには警告を出さない
バージョン1.3.3(2015年12月2日リリース)¶
誤りを修正する¶
#2177:修復並行保留
#2012:以下の場合、異常を修復します。
numfig_format
無効です。#2142:非小型化されたJSコードを提供
sphinx/search/non-minified-js/*.js
PyPI上のソースコード配布に用いる.#2148:非ASCIIドキュメントを使用してdevhelpオブジェクトを構築する際にエラーが発生します。
バージョン1.3.2(2015年11月29日リリース)¶
追加された機能¶
#1935:LaTeX_ELEMENTSで“numfig_format”を上書き可能にします。
誤りを修正する¶
#1976:Windows環境では動作しないので、バージョン2.0のBabelの使用を避けます。
互換性を実現するために“default.cs”様表(“classic.cs”の導入)を追加します。
#1788:タイトルオプションが存在する場合、Graphviz拡張に異常が発生します。
#1789:
:pyobject:
オプションliteralinclude
命令はクラス定義の後に以下の行を含む#1790:
literalinclude
頭と尾の空行を取り除く#1802:heme.confがプラグイン·トピックを‘Inherit’として使用すると、プラグイン·トピックが自動的にロードされます。平井隆幸のおかげです。
#1794:雪花石膏またはSPHINX_RTD_THEME拡張されたカスタムトピックから基本トピックが見つかりません。
#1834:docutilsの互換性-0.13:docutils.io.FileInput原因TypeErrorのHandle_io_Errorsキーワードパラメータ。
#1823:‘’Sphinx-apidocである<MODULE_PATH>は非友好的な誤りを招く.今は‘自動的に絶対経路に変換する.
修復設定は,メタデータの拡張をサポートしていない場合に発生する崩壊である.
#1784:非縮小JSコードが提供されています。
sphinx/search/non-minified-js/*.js
#1822,#1892:修復#1061の復帰。Sphinx-1.3 b 3のため,自動集約は導入したメンバのための文書を生成することができない.エリック·ラルソンのおかげです
#1793,#1819:“別参照”テキスト出力に改行が欠落しています。平井隆幸のおかげです。
#1780,#1866:“make text”は“class”キーワードを2回表示します。平井隆幸のおかげです。
#1871:単一列多行テーブルのLaTeX出力が修復されました。
Python 3.5におけるHTMLParserError異常の欠如の問題を解決する。
#1949:使用
safe_getattr
カスタマイズされたアクションを持つ記述子を用いて中止することを避ける.#1915:スマート引用符は、伝票フィールドタイプの注釈に生成されません。
#1796:py 3で、UnicodeDecodeErrorを自動的に.mo構築します。
#1923:バーベリンラテックス元素が空でない場合にのみバーベリン機能が使用される。
#1942:WebSupportのKeyErrorを修復します。
#1903:タームリスト用語を修復する奇妙なidが生成されます。
make text
定義リスト項に1つ以上の分類子があれば,以下のように崩れてしまう.term : classifier1 : classifier2
それがそうです。#1855:make gettextは、分類器付き定義リストで破損したpoファイルを生成します。
#1869:非ASCII文字を含むファイルを修復処理する際の問題。マーヴィン·シュミットのおかげです
#1798:参照されているタイトルの建築用ラテックスを修復します。
#1725:py 2環境では、doctestは非ASCII文字を使用することにより
'ascii' codec can't decode byte
例外です。#1540:toctreeのループ参照の実行エラーを修復します。
#1983:I 18 N変換機能使用節名の参照を中断します。
#1990:LaTeXでToctreeのタイトルをtableOfコンテンツのタイトルとして使用する
#1987:修復と記号を無視する
:menuselection:
そして:guilabel:
浅談ラテックス助剤#1994:翻訳およびネットワークサポート機能をよりサポートする非標準解析器(推奨タグ解析器)現在,docutils変換の間,node.rawsourceはnode.astext()に戻る.
#1989:Windows上の“make blahblah”には、毎回ライオンのイメージ-Buildのヘルプメッセージが表示されます。これは,Sphinx-1.3.0/1.3.1で生成された誤りmake.batによるものである.
Py 2環境では,sphinx-ickstartにより生成されたconf.pyは‘version’と‘Release’にu個のプレフィックス構成値を付加すべきである.
#2102:Windows+Py 3で使用
|today|
非ASCII日付フォーマットはUnicodeEncodeErrorを引き起こすだろう。#1974:Unbound LocalError:使用時に代入前に参照されるローカル変数‘domain’
any
キャラクターとsphinx.ext.intersphinx
同じ時間に。#2121:単語がページタイトルとページ内容で交差している場合、多文字検索はページを検索しません。
#1884、#1885:プラグインhtmlトピックは、他のプラグインのトピックを継承することができません。鈴木さんのおかげです。
#1818:
sphinx.ext.todo
命令は以下の場合に壊れたhtmlクラス属性を‘Admonition-’と生成する.language
‘ru’や‘ja’のように非ASCII言語領域を用いて指定する.この問題を解決するためにtodo
指令は使用可能である:class:
選択します。#2140:ラテックスへの脚注の修復表の問題
#2127:MecabBinderのhtml検索機能は、Python 3では機能しません。内田朋子(Tomoko Uchida)のおかげである。
バージョン1.3.1(2015年3月17日リリース)¶
誤りを修正する¶
#1769:既存のファイル/ディレクトリをカバーしないターゲットディレクトリのクイックスタートファイル/ディレクトリの生成を許可します。若山志郎のおかげです。
#1773:Sphinx-QuickStartオプションパラメータとして非ASCII文字は受け付けていません。
#1766:“少なくともPython 2.6を実行する”というメッセージは、せいぜい誤解にすぎません。
#1772:文書文字列の交差参照、例えば
:param .write:
建物を破壊する。#1770、#1774:
literalinclude
ファイルが空の場合は異常が発生します。平井隆幸のおかげです。#1777:Sphinx 1.3追加のトピックをロードできません。Tell-kのおかげです。
#1776:
source_suffix = ['.rst']
以前のバージョンでは非友好的なミスを招いた。#1771:自動.mo生成は正常に動作しません。
#1783:autodoc:Python 2 Unicode文字列のエントリを許可します。 __all__. 延斯·ヘゼハイ·ニールソンのおかげです。
#1781:設定
html_domain_indices
タイプチェック警告が開始されます。
バージョン1.3(2015年3月10日リリース)¶
互換性のない変更¶
Roles
ref
,term
andmenusel
now don't generate emphasis nodes anymore. If you want to keep italic style, adapt your stylesheet.役柄
numref
用途%s
特殊な文字として数字の位置を指示する#
象徴する。
追加された機能¶
利便性コマンドおよびロールをC++ドメインに追加:コマンド
cpp:var
の別名としてcpp:member
、役割:cpp:var
の別名として:cpp:member
役割をしていますany
任意のC++宣言操作を交差参照するために使用される.#1577,#1744♪the
source_suffix
配置値は、現在、複数の接尾辞のリストであってもよい。ソースコード解析器をソースコード接尾辞で指定する機能を付加した
source_parsers
値を配置する。#1675:Apple HelpBooksを構築するための新しいジェネレータAppleHelpBuilderが追加されました。
誤りを修正する¶
1.3 b 3変更は、“foo bar”および“Version Changes in 1.3:foo bar”のような重複msgidを以前に含むgettext出力を中断する。
#1745:脚注自体が脚注マークを有する場合、Laex生成器は、最大再帰的深さを超えることをもたらす。
#1748:Python 2.6のsphinx/ext/ifconfig.pyの構文エラーです。
#1658、#1750:オプションが-、/または+で開始されない場合、リンクは作成されません(警告)。平井隆幸のおかげです。
#1753:C++では、より複雑な宣言の欠落サポートが追加されています。
#1700:追加
:caption:
オプション:toctree
それがそうです。#1742:
:name:
option is provided fortoctree
,code-block
andliteralinclude
directives.#1756:1.3 b 3から導入された検索のチャプタタイトルが正しくありません。
#1746:C++、名前発見プロセスが修復され、欠落したルックアップが宣言に追加されます。
#1765:C++、完全限定名を使用するために古いid生成を修復します。
書類¶
#1651:追加
vartype
Pythonドメインのフィールド記述。
バージョン1.3 b 3(2015年2月24日リリース)¶
互換性のない変更¶
依存性要求更新:docutils 0.11,Pygments 2.0
♪the
gettext_enables
設定値は名前が変更されましたgettext_additional_targets
それがそうです。#1735:https://docs.python.org/ではなく使用
http
合意する。それは使われていますsphinx.ext.intersphinx
まだいくつかの書類があります。
追加された機能¶
#1346:デフォルト·トピックの追加;
“雪石膏”というテーマを加える。
‘ライオンの顔像_rtd_テーマ’というテーマを追加します。
“デフォルト”htmlテーマは“古典”と再命名されました。“デフォルト”はまだ利用可能ですが、新しい“雪の石膏”のテーマを使うことを提案します。
増列する.
highlight_options
値を配置する。♪the
language
現在,HTMLテンプレートに配置値を用いることができる.♪the
env-updated
イベントは、返却値を返すことができ、この値は、書き換えが必要な追加の文書名の反復可能であると解釈される。#772:C++では、スコープおよび非アクティブドメインがサポートされています。列挙範囲に加えて,範囲を限定しない列挙における列挙数は親範囲に注入される.
増列する.
todo_include_todos
クイックスタートプロファイルの構成オプションは,文書で述べたように処理する.HTML breadcrumb Itemsタグには,クラス“nav-item”と“nav-item-N”(例えばnav-item-0,1,2...)がある.
新しいオプション
sphinx-quickstart --use-make-mode
シェーマ面像を用いてMakefileモードを構築するためのMakefileを生成する。#1235:I 18 N:設定されている場合、複数のノードを変換することができます。
gettext_additional_targets
Conf.pyにあります。サポートされるノードは、“文字ブロック”
‘doctest-block’
“生食”
“イメージ”
#1227:追加
html_scaled_image_link
Conf.pyの構成オプションは、スケーリングされた画像リンクを制御するためのものです。
誤りを修正する¶
LaTeXコンパイラは現在,複数行にまたがるセルに対して正しいタグを生成することができる.
#1674:モジュールの場合
__all__
文字列リストではありません。#1629:VerbatimBorderColorを使用してLaTeXのコードブロックにフレームを追加する
Windows上では,Shinxを呼び出した場合,make-modeはWin 32プラットフォーム上では機能しない.
python sphinx-build.py
それがそうです。#1687:LinkCheckは、401個の許可されていない応答を“仕事”と見なします。
#1690:以下を含むディレクトリツリー
glob
オプションはまた、明確なタイトルを有する単一の文書のエントリを含むことができる。#1591:C++要素のHTML検索結果は、正しいページ間リンクを持っています。
Bizstyleテーマ:入れ子の長いタイトルページは長いパンくずが発生し、ページレイアウトを破壊します。
Bizstyleテーマ:すべてのパンくずプロジェクトは、あるモバイルブラウザ(IPhone 5 S Safari)で“トップ”になります。
#1722:リカバリ
toctree()
1.3 b 1で変更されたテンプレート関数アクション。#1732:I 18 N:ローカル化テーブルタイトルに異常が発生します。
#1718:
:numref:
ラベルの大文字には適用されません#1630:CSS衝突を解決し、
div.container
文字ブロックパッケージのCSSターゲットは現在改名されていますdiv.literal-block-wrapper
それがそうです。sphinx.util.pycompat
後方互換性が回復された;Sphinx 1.4で削除される予定だ。#1719:ラテックス作家は尊重しない
numref_format
見出しの選択肢
バージョン1.3 b 2(2014年12月5日リリース)¶
互換性のない変更¶
バンドルされたez_setup.pyを更新するには、Python 2.6以降のsetuptools-7.0の更新が必要です。
追加された機能¶
#1597:新しいテンプレート名を返す可能性を追加します。
html-page-context
それがそうです。PR#314、#1150:構成値のタイプを確認します。設定された値とデフォルト値のタイプが異なり、共通の重要な基本クラスを共有しない場合、警告が開始される。
誤りを修正する¶
PR#311:Sphinx-QuickStartはpython 3.4では機能しません。
手入れをする.
autodoc_docstring_signature
クラス文書文字列中の署名は使用しない.ソースファイルを追加した場合,再構成は意外に崩壊する.
#1607:“HOWTO”クラスを使用してlatexpdfを構築した場合の崩壊の修復
#1251:再修復。深さ:TocDepth:の部分はlocaltocサイドバーに表示されるべきではありません。
ライオンの顔が車輪パッケージで実装されているような場合,Win 32プラットフォームではmake-modeを使用することはできない.
バージョン1.3 b 1(2014年10月10日リリース)¶
互換性のない変更¶
Python 2.5、3.1、3.2はもはやサポートされません。
Docutilsは0.9以上のバージョンではサポートされていません。
削除されました
sphinx.ext.oldcmarkup
延期する。The deprecated config values
exclude_trees
,exclude_dirnames
andunused_docs
have been removed.新しいノードです
sphinx.addnodes.literal_strong
強いフォント字面で表示されるべきテキスト(すなわち、スマート引用符なし)のために追加された。このノードを処理するためにカスタムライタを調整しなければならない.PR#269,#1476:交換
<tt>
ラベル根拠<code>
それがそうです。CSSにいくつかのスタイルが含まれている場合、ユーザ定義スタイルテーブルが更新されなければならないtt>
ラベル。小宮武のおかげです。#1543:
templates_path
自動的に追加されますexclude_patterns
Templatesディレクトリ中のautosumary rstテンプレートの読み込みを避ける.自己定義域は新しいものを実現すべきだ
Domain.resolve_any_xref
方法を使う.any
役割が正常に働く。Gettext builder:デフォルトの場合,gettextは生成されたPOTファイルにUUIDメッセージを送信しない.設定してください
True
至るgettext_uuid
UUIDメッセージを送信する.またもしpython-levenshtein
第三者パッケージを実装することで,計算時間を短縮することができる.Gettext生成器:デフォルトで“index”ノードの抽出/適用を無効にします。‘index’を設定してください。
gettext_enables
索引項目の抽出を可能にする。PR#307:LaTeXにフレームをコードブロックに追加する。小宮武のおかげです。
追加された機能¶
Python 3.4に対するサポートを追加します。
Docutils 0.12のサポートの追加
増列する.
sphinx.ext.napoleon
NumPyおよびGoogleスタイルの文書文字列の拡張をサポートします。ソースファイルの並列読み出し(解析)のサポートを追加した.
sphinx-build -j
選択します。第三者拡張の互換性をチェックする必要があり,第三者拡張が構築環境オブジェクトに情報を格納していれば,それを調整する必要がある可能性がある.見env-merge-info
それがそうです。追加
any
役割、その役割を探すために使用することができます any キー入力. any ドメインです。自己定義域は新しいものを実現すべきだDomain.resolve_any_xref
方法はそれを正常に作動させる。例外ログには、Sphinxが発行した最後の10個のメッセージが含まれています。
拡張バージョンのサポートが追加されました(返された文字列から
setup()
これらはバックトラックログファイルに表示される).拡張モジュールのバージョン要件は、プロジェクトで新しいものを使用することができますneeds_extensions
値を配置する。属性は、文書内のデフォルトのロールを変更します。 default-role 指示は今支持されている。
PR#214:14言語に対する語幹処理支援が追加されているため,内蔵された文書検索は現在これらの言語を扱うことができる.柴川義貴に感謝します。
PR#296, PR#303, #76: numfig feature: Assign numbers to figures, tables and code-blocks. This feature is configured with
numfig
,numfig_secnum_depth
andnumfig_format
. Alsonumref
role is available. Thanks to Takeshi Komiya.PR#202:許可されます“。“~”を引用の接頭辞とする
:param:
Pythonのドキュメントフィールドです。PR#184:追加
autodoc_mock_imports
また,自動記録をシミュレートする際に存在する必要のない外部モジュールの導入を許す.#925:コマンドラインにリストタイプの構成値を提供することができます。
-D key=val1,val2
それがそうです。#668:許可行番号Yes
code-block
そしてliteralinclude
命令は任意の行番号で始まり、新しいものを使用しますlineno-start
選択します。PR#172、PR#266:The
code-block
そしてliteralinclude
指令は今ではcaption
オプションは、出力中のコードの前にファイル名を表示します。小宮武さんのハックさんのおかげです。Shinx-QuickStartにおける文書言語の入力を提示する.
PR#217:生成されたgettextディレクトリ中のUUIDおよび位置情報を抑制するために配置値が追加される。
PR#236、#1456:apidoc:-Mオプションを追加して、モジュール文書をサブモジュール文書の前に置きます。ウェス·ターナーとリュック·サヴルのおかげです
#1434:jquery.jsおよびundercoree.jsに非縮小JSファイルを提供し、ファイルのソースを明示的に縮小します。
PR#252、#1291:Windowsカラーコンソールをサポートします。私が31歳のおかげです。
PR#255:LaTeX参照を生成する際に、ノード上で定義されたIDにLaTeXオブジェクト/アンカーを挿入する。オリヴィル·ヘティエのおかげです
PR#229:他の翻訳者の登録を許可します。ラッセル·シムのおかげです
以下に示すように、app.set_Translator()APIを追加してDocutils変換器クラスを登録または上書きします。
html_translator_class
それがそうです。PR#267,#1134:‘diff’パラメータをequalincludeに追加します。リチャード·ウォールと和歌山志郎に感謝します。
PR#272:‘bizstyle’トピックが追加されました。熊谷昭二に感謝します。
自動コンパイル
*.mo
以下の位置からのファイル*.po
書類は以下の場合gettext_auto_build
True(デフォルト値)であり、*.po
比*.mo
ファイルです。#623:
sphinx.ext.viewcode
導入した関数/クラス名をサポートする.PR#275:
sphinx.ext.intersphinx
マルチターゲット在庫をサポートします。ブリジタ·シプツのおかげですPR#261:追加
env-before-read-docs
イベントは、環境が文書を読み取る前に文書の順序を修正するように接続することができる。#1284:記録された計画オプション
option
今から見ることができます+
それがそうです。PR#291:タイトル
code-block
審判の目標の肩書きとされています。小宮武のおかげです。PR#298:新しいインタフェースの追加:
add_latex_package()
それがそうです。小宮武のおかげです。#1344:追加
gettext_enables
‘index’の抽出を有効にして、テキストリストの出力を取得する/生成された文書に翻訳ディレクトリを適用します。PR#301,#1583:コマンドの行番号を許可する
literalinclude
含まれている書類にマッチする場合は、新しいものをご利用くださいlineno-match
選択します。ジェッペ·ピアのおかげですPR#299:ライオンのイメージに様々なオプションを追加-クイックスタート。ミュートモードオプション
--quiet
ウィザードモードをスキップします。若山志郎のおかげです。#1623:指定されたリターン·タイプを使用する
:rtype:
可能であれば、今はリンクになっています。
誤りを修正する¶
#1438:jQueryバージョンは1.8.3から1.11.1に更新されます。
#1568:“真ん中”コマンドを修復するには、参照時のクラッシュが含まれます。
現在、sphinx.ext.autocは再びpython-2.5をサポートしています。
#1563:
add_search_language()
パラメータタイプが正しいAssertionErrorを引き起こす.リコマンのおかげです。#1174:ロール内部アプリケーションを修復するスマート引用符は、以下の通りです。
program
あるいは…。makevar
それがそうです。PR#235:WebSupportのレビューデータベース·アーキテクチャnode_idフィールドの長さが欠落しています。独唱のおかげです。
#1466,PR#241:CPPドメイン解析器がC+11“可変テンプレート”宣言の問題を解析できないことを修復します。ビクター·ズベロビッチのおかげです
#1459,PR#244:デフォルトのmathjax jsパス指向を修復
http://
これによりHTTPSサーバ上でミキシングコンテンツエラーが発生する.SbrandtbとRobo 9 kのおかげですPR#157:autoc@Property修飾属性から偽署名を除去する.デビッド·ハムのおかげです
PR#159:クイックスタートによって生成されたMakefileおよびMake.batにオーバーレイオブジェクトを追加します。マティアス·トロフィーのおかげです
#1251:toctreeの指定:NUMBED:OPTIONと:tocDepth:METADATAの場合、深さが大きい
:tocdepth:
縮小しています。PR#260:ラテックス出力のために引用タグに下線をコードする。ルナート·フリックのおかげです
PR#264:修復使用不能:Name:オプション解析地物ノードの外部参照。小宮武のおかげです。
PR#265:Graphvizノードを捕捉したタイトルを外部参照で修復できません。小宮武のおかげです。
PR#263,#1013,#1103:C++領域を上書きする。ジェイコブ·レック·アンダーソンに感謝します
見つかったすべての入れ子名とテンプレートパラメータを指すハイパーリンク(#1103)。
任意の場所の関数タイプがサポートされ、例えば、std::Function<bool(int,int)>(#1013)である。
仮想関数をサポートする。
関数パラメータの解釈を,void f(Arg)はargが名前ではなくパラメータタイプであることを表す標準プロトタイプ宣言に変更する.
テストを更新する。
文書は更新され、どの宣言および命名空間宣言が宣言および交差参照ルックアップにどのように影響を与えるかが詳細に記載されている。
索引名は今違うかもしれません。要素はその完全限定名に応じてインデックスを作成する.この行為を変更することはかなり容易であるはずであり,名前空間/クラスごとにインデックス付けされる可能性もある.
PR#258、#939:以下の項目に予約オプションを追加します。
code-block
そしてliteralinclude
それがそうです。ザファール·シディキのおかげですPR#268:固定番号部分はsinglehtmlモードでは機能しません。節IDの衝突の問題が存在するため、それはまだ一時的な修復である。小宮武のおかげです。
PR#273,#1536:番号付きループディレクトリツリーを使用して実行エラーを修復します。小宮武のおかげです。
PR#274:tocotreeにURLが出現した場合、そのURLをデフォルトタイトル値に設定する。小宮武のおかげです。
PR#277,#1513:パラメータリストにおける関数ポインタのハイライト表示
c:function
それがそうです。小宮武のおかげです。PR#278:tocotreeがONLY命令の下に置かれている場合、修復部分エントリは2回表示される。小宮武のおかげです。
#1547:pgen 2マーカでは認識できません
...
文字(省略番号はpy 3を表す).PR#294:LaTeX生成器では、タイトルおよび本文の分離を回避するために、text_blockを書き込む際にフローティング環境をカプセル化する。小宮武のおかげです。
PR#295、#1520:
make.bat latexpdf
仕組みはcd
現在のディレクトリに戻ります。ピーター·サットのおかげです。PR#297,#1571:すべてのビルダにimgpath属性を追加します。これにより,ビルダ拡張の開発が容易になる.小宮武のおかげです。
#1584:HTML“top”リンクのmaster docを指します。
#1585:Sphinx-1.2.3破損したモジュールの自動要約。
#1610:MeCab検索オプションを有効にし、python-mecabがインストールされていない場合、SphinxはAttributeErrorをもたらします。
#1674:モジュールの場合
__all__
文字列リストではありません。#1673:クラッシュを修復する
nitpick_ignore
そして:doc:
参考資料。#1686:ifconfigコマンドはデフォルト構成値に関心がありません。
#1642:修復Chromeに検索結果が1つしか出現しません。
書類¶
タグ文法に関する説明を加える. (
doc/markup/misc.rst
)
バージョン1.2.3(2014年9月1日リリース)¶
追加された機能¶
#1518:
sphinx-apidoc
命令は今1つあります--version
バージョン情報を表示して終了するオプション新しい地域:ヘブライ語、ヨーロッパポルトガル語、ベトナム語。
誤りを修正する¶
#636:LaTeXバージョンでは、文字ブロックに直接シングル引用符が保持されています。
#1419:生成されたI 18 N sphinx.jsファイルに‘.js_t’および‘.html’のメッセージディレクトリ項目が欠落しています。この問題はSphinx-1.1から導入された
#1363:I 18 Nの修復:pythonドメインとcurrentmodule命令またはcurrentclass命令との交差参照が欠落しています。
#1444:属性文書文字列から作成されない記述を自動的に集約します。
#1457:python 3環境では、リンク先urlがハッシュ部分を含む場合、make linkcheckは“”bytes“オブジェクトを暗黙的文字列に変換できない”エラーを招きます。ホルヘ·Cのおかげです
#1467:autMethodが存在しないメソッドを指定した場合、Python 3に例外が発生します。
#1441:自動集約ではネストクラスを正しく処理できません。
#1499:呼び出し不可の使用
setup
Conf.pyでは,現在のsphinx-buildはユーザに優しいエラーメッセージを送信する.#1502:autocでは、逆スラッシュを含むパラメータのデフォルト値の表示が修復されます。
#1226:autodoc,autosumary:自動モジュール読み込みsetup.pyは、インストール手順を呼び出して実行します。
sys.exit()
それがそうです。現在,ShinxはSystemExit異常を回避し,意外な終了なしに警告を発している.#1503:PY:Functionコマンドは、空リストを使用してデフォルトパラメータを指定する際に署名エラーを生成します。
[]
それがそうです。ヘルター·ジェンソンのおかげです#1508:非ASCIIファイル名は、singlehtml、laex、man、texinfo、および変更を生成する際に異常を引き起こします。
#1531:Python 3環境では、General部分に‘source_link=true’を持つdocutils.confがタイプエラーを起こします。
PR#270,#1533:継承グラフ命令と共に使用される場合、非ASCII文書文字列は、UnicodeDecodeErrorをもたらす。若山志郎のおかげです。
PR#281、PR#282、#1509:TODO拡張はWebSupportと互換性がありません。小宮武のおかげです。
#1477:gettextは、テーブルまたはリストのnodes.lineを抽出しません。
#1544:
make text
表セルが空の場合は誤ったテーブルを生成する.#1522:表の脚注がLaTeXに2回表示されます。Sphinx-1.2.1から#949まで,この問題が発生している.
#508:setup.pyコマンドから呼び出されると、Sphinxがゼロで終了するたびに終了します。元カレ。
python setup.py build_sphinx -b doctest
Doctestが失敗してもゼロに戻る.
バージョン1.2.2(2014年3月2日リリース)¶
誤りを修正する¶
PR#211:存在するかどうかをチェックする
html_logo
ファイルでは、基本名ではなく、完全な相対パスをチェックしてください。PR#212:autodocと
__init__
文書文字列の方法はありません。PR#213:インストールコマンドに欠落しているインポートを修復します。
#1357:レコードされたオプション名
option
今再び折れた番号やスラッシュで始まることが許されず、それらを引用することは正常に動作するだろう。#1358:“ワイルドカード”スタイル参照を使用したソースディレクトリの外部画像パスの処理が修復されました。
#1374:1行目が句読点で終了しないときに自動的にまとめて長すぎる要約を生成する問題が修復されました。
#1383:phhinx-apidocのPython 2.5互換性を修復します。
#1391:実際には、ライオンのイメージ-クイック入門では、“pngath”と“mathjax”の拡張子の併用は禁止されています。
#1386:入口ポイント機構を修復し、複数のトピックのエラーを追加します。
#1370:開始ではなく、テキスト·ライタの“toctree”ノードを無視します。
#1364:修復‘.’場合‘make gettext’は失敗するTodolist:‘コマンドが存在する.
#1367:PR#96の変更を修復し、sphinx.util.docfields.Field.make_fieldインタフェース/アクションを中断します。
item
パラメータ使用法。
書類¶
拡張した documentation about building extensions それがそうです。
バージョン1.2.1(2014年1月19日リリース)¶
誤りを修正する¶
#1335:感嘆符プレフィックス付き自動集約テンプレート再ロードを修復します。
{{% extends "!autosummary/class.rst" %}}
無限再帰関数呼び出しを招く.これは広報181号によるものだ。#1337:AutoDoctの修復
autoclass_content="both"
無用の使いobject.__init__
類になっていない__init__
それがそうです。これは#1138の変化によるものである.#1340:language=‘ja’で生成されたHTMLで英単語を高速に検索できません。
#1319:次のような場合、崩れないでください
html_logo
ファイルは存在しません。#603:HTML化されたタイトルを使用して検索インデックスを構築しない(タイトルに文字があるページごとに“文字”を見つけることになります)。
#751:long tableを使用して、LaTeXのページを超えるリストを作成することができます。
#764:JS検索で小文字の無効語を常に検索してください。
#814:autodoc:防止なし
__bases__
それがそうです。#932:autodoc:次の場合は崩れない
__doc__
文字列ではありません。#933:故障が発生した場合、崩れないでください
option
値のフォーマットは正しくありません(スペースは含まれていますが、オプション名は含まれていません)。#908:Python 3では、LaTeXからのエラーメッセージがpngath拡張で正しく処理されます。
#943:自動要約では、“1文目”に大文字が含まれている場合、文書文字列から抽出する“第1文”が認識される。
#923:pngathによって生成された画像をキャッシュする際には、LaTeX文書全体を考慮してください。これは次のような状況で正確に再構築されます
pngmath_latex_preamble
変化する。#901:Sphinx数学拡張がアクティブ化されていない場合、docutilsの新しい“数学”タグが使用された場合に警告が発行されます。
#845:コードブロックにおいて、選択された字句解析器が失敗した場合、依然として行番号が表示される(構成されている場合)。
#929:LaTeX出力の解析文字ブロックを正しくサポートします。
#949:ライオンのイメージが詰まったtabulary.styを更新します。
#1050:匿名タグの追加
objects.inv
以下のように引用するintersphinx
それがそうです。#1095:常に“スクロール”トピックに含まれている印刷メディアスタイルテーブルを修復します。
#1085:クラス記述が以下のものを有する場合、現在設定されていないクラス名を修復する
:noindex:
準備ができました。#1181:autocコマンドのオプションエラーをより優雅に報告します。
#1155:修復Cで定義されたメソッドをPython 3の属性として自動的に記録します。
#1233:intersphinxで“class”および“exc”ロールを有するPythonクラスおよび例外を検索することができます。
#1198:“figwidth”オプションを“image”に設定できます。 figure Docutilsによって記録されたコマンド。
#1152:Python 3コードのpycode解析エラーを修復し、Python 2およびPython 3の2つのシンタックスバージョンを含み、実行中のPythonバージョンに適切なバージョンをロードします。
#1017:ユーザーを助け、いつパラメータを使用するかをユーザーに伝える
option
必要なフォーマットと一致しません。#1345:2つのエラーを修復する
nitpick_ignore
今、あなたは商店環境を削除することなく、変更を有効にすることができます。#1072:JS検索では,語幹の前に単語を小文字で修復することで大文字単語を検索する問題.
#1299:使
math
指令はより一致しており,ラテックス出力に空環境が生じることを回避した。#1308:“オリジナル”ノードを検索インデックスに提供する前に、“オリジナル”ノードのコンテンツからHTMLタグを除去する。
#1249:マニュアル文書のリピートラテックスページ番号を修復します。
#1292:リンクチェッカでは、HTTP 405に拒否された場合にHEAD要求を再試行する。また,リダイレクトコードをより明らかにし,出力をより明らかに調整する.
#1285:Cドメインオブジェクトとノードタイトルの間の名前の衝突を回避します。
#848:インクリメンタル再構成では、最新のコードが常に使用されています。
sphinx.ext.viewcode
延期する。#979、#1266:修復中の除外処理
sphinx-apidoc
それがそうです。#1302:リペア復帰
sphinx.ext.inheritance_diagram
浸漬されてはいけない種類を記録すると。#1316:ハードコードの削除
font-face
Epubトピックからの資源。#1329:.poファイルの空翻訳msgstrを使用してバックトラックを修復します。
#1300:場合によっては翻訳文書で機能しない参照を修復します。
#1283:削除された文書の文書ツリーの変更ファイルへのアクセスを試みた場合のエラーを修復検出します。
#1330:修復
exclude_patterns
中のサブディレクトリの行為html_static_path
それがそうです。#1323:空に送信された問題を修復します。
<ul>
HTMLコンパイラにおけるタグは,これは有効なHTMLではない.#1147:“singlehtml”ビルダにサイドバー検索ボックスを表示しないでください。
書類¶
#1325:“Intersphinx”チュートリアル部分が追加されました。 (
doc/tutorial.rst
)
バージョン1.2(2013年12月10日リリース)¶
追加された機能¶
増列する.
sphinx.version_info
Sphinxバージョンをプログラミングチェックするためのタプル。
互換性のない変更¶
削除されました
sphinx.ext.refcounting
拡張-これはCPythonに非常に特定されており、メインリリースに位置していません。
誤りを修正する¶
復元
versionmodified
バージョン追加/変更および廃棄命令のCSSクラス。PR#181:修復
html_theme_path = ['.']
すべてのドキュメントを常に再構成するトリガです(この変更は、現在の“トピック変更による再構成”機能を維持します)。#1296:HTMLヘルプでデフォルト領域に生成されたHTMLファイルの無効文字セットを修復します。
PR#190:修復gettextは、他のブロックでグラフィックスタイトルおよび標準タイトルを抽出しません。マイケル·シュレンクのおかげです
PR#176:SETUP_COMMANDテストが常にSphinxに導入できることを確認します。ドミトリー·シャヘネフのおかげです
#1311:C言語環境およびPython 3のtest_linkcode.test_htmlの修復に失敗しました。
#1269:Python 3.2以降を使用してResourceWarningを修復します。
#1138: Fix: When
autodoc_docstring_signature = True
andautoclass_content = 'init'
or'both'
, __init__ line should be removed from class documentation.
バージョン1.2ベータ3(2013年10月3日リリース)¶
追加された機能¶
Sphinxエラーログファイルには、デバッグを支援するためにロードされた拡張リストが含まれます。
互換性のない変更¶
PR#154:LaTeXクラス名から“sphinx”プレフィックスが削除されますが、“sphinxmanual”および“sphinxhowto”は除外されます。今、‘sphinx’プレフィックスを持たないカスタム文書クラスを使用することができます。エリック·Bのおかげです
誤りを修正する¶
#1265:I 18 Nの修復:名前付きオブジェクトからのノード名を変換する際に崩壊します。
誤った条件は,通常index.rstである1ページ目の検索機能を破壊する.この問題は1.2 b 1に導入される.
#703:Sphinxが非ASCII文字を含むファイル名を復号できない場合、Sphinxは現在、UnicodeErrorを捕捉し、例外を開始するのではなく、可能な場合に実行を継続する。
バージョン1.2ベータ2(2013年9月17日リリース)¶
追加された機能¶
apidoc
デフォルトでは“_private”モジュールを無視し、オプションがあります-P
彼らも含めて。apidoc
モジュール文書文字列にRESTヘッダが含まれていれば,パケットやモジュールを生成しないヘッダを選択することができる.PR#161:
apidoc
各モジュールは、すべてのモジュールを1つのページに組み合わせるのではなく、独立したページに書き込むことができる。ビルダ:ディレクトリ更新時にi 18 nターゲット文書を再生成する.
HTMLコンパイラにおけるdocutils.conf‘Writers’と‘html 4 css 1 Writer’部分をサポートする.LaTeX,manpage,texinfoコンパイラもそれぞれの“コンパイラ”部分をサポートしている.
新しい
html_extra_path
設定値は,HTML出力ディレクトリに直接コピーすべきファイルを含むディレクトリを指定することを可能にする.モジュールデータと属性のAutodocコマンドは現在サポートされている.
annotation
オプションは、データ/属性値のデフォルト表示をカバーすることができるようにする。PR#136:Autodocコマンドは現在サポートされています。
imported-members
オプションは、異なるモジュールから導入されたメンバを含むようになります。新地域:マケドニア語、サンガロー語、インドネシア語。
Setuptoolsプラグイン機構を用いたトピックパケット集合.
互換性のない変更¶
PR#144,#1182:gettext builderが生成したpot-create-date上の強制タイムゾーンオフセットはLocalTimeZoneである.MasklinnとJakub Wilkのおかげで
誤りを修正する¶
PR#132:jQueryバージョンを1.8.3に更新します。
PR#141,#982:Python 3を使用してPNGファイルを作成する際にクラッシュしないようにします。これはMarcin Wojdyrのおかげだ。
PR#145:並行構築では、Shinxは2番目に書き込む文書ファイルを破棄する。TYTICHのおかげです。
PR#151:LaTeXのいくつかのフォームスタイルが更新されます。
PR#153:“Extensions”構成値を上書きすることができます。
PR#155:いくつかのC++11関数限定子のサポートが追加されています。
FIX:テンプレートにUTF-8コード文字列が含まれている場合,‘make gettext’はUnicodeDecodeErrorを引き起こす.
#828:spect.getfullargspec()を使用して、キーワードパラメータのみを持つ関数をPython 3に記録することができます。
#1090:FIX I 18 N:同一行における複数の交差参照(Term,ref,doc)は、同じリンクを返す。
#1157:‘globaltoc.html’と隠蔽toctreeの組み合わせは異常をもたらします。
#1159:Pythonモジュールが誤って生成したオブジェクトリストを修復し、影響を受けたリストの処理を修復するためにIntersphinxに解決方法を追加します。
#1160:参照ターゲットの欠落は、AssertionErrorをもたらします。
#1162,PR#139:singlehtml builderは、画像を_image/にコピーしていません。
#1173:JJIA 2.7がPython<3.3およびPython<2.6に適合しなくなったため、setup.py依存を調整します。アレクサンダー·ドゥッペのおかげです
#1185:Pythonモジュールが誤ったコードを宣言した場合、または宣言コードがなく、非ASCII文字が含まれている場合、クラッシュしないでください。
#1188:“プロジェクトバージョン”に非ASCII文字が含まれている場合、Sphinx-QuickStartはUnicodeEncodeErrorを開始します。
#1189:クイック入門で“項目名”として全角文字を用いた場合、“タイトルの下線が短すぎる”という警告が与えられます。
#1190:クイックスタートの“プロジェクト名”に非ASCII文字が使用されている場合、tex/texinfo/manファイル名にベース名(拡張子のみ)が出力されます。
#1192:マニュアル·ページ·ライタにおけるハイパーリンクの転送問題を修復します。
#1193:修復I 18 N:同じ行の複数のリンク参照は、同じリンクを返します。
#1176:修復I 18 N:自動番号命名脚注および自動記号脚注は、脚注参照番号が欠落しています。
PR#146,#1172:並列構築におけるZeroDivisionErrorを修復します。TYTICHのおかげです。
#1204:エラー生成されたローカルIntersphinxオブジェクトへのリンクを修復します。
#1206:I 18 N:gettext未翻訳警告コマンドのタイトルを修復します。
#1232:Sphinxは、Windows上で破損したePubファイルを生成します。
#1259:イベントが発行されたときにデバッグ出力呼び出しを保護し、任意のオブジェクトのrepr()実装による構築失敗を防止します。
#1142:Mac OS X上のrstファイル名のNFC/NFD標準化の問題を修復します。
#1234:無視文字列はスペース文字のみで構成されています。
バージョン1.2ベータ1(2013年3月31日リリース)¶
互換性のない変更¶
除去
sphinx.util.compat.directive_dwim()
そしてsphinx.roles.xfileref_role()
これらは1.0版から使用が推奨されていない.PR#122:で与えられたファイル
latex_additional_files
Sphinxに含まれるtexファイル、例えばsphinx.sty
それがそうです。PR#124: the node generated by
versionadded
,versionchanged
anddeprecated
directives now includes all added markup (such as "New in version X") as child nodes, and no additional text must be generated by writers.広報#99:
seealso
命令は現在,カスタムではなく警告ノードを生成する.seealso
ノードです。
追加された機能¶
入札を加える.
♪the
toctree
指令とtoctree()
テンプレート関数は現在1つありますincludehidden
オプションは、隠れたディレクトリツリーエントリ(エラー#790および#1047)を含む。虫が1匹いるmaxdepth
オプション、使用するtoctree()
テンプレート関数は修復された(エラー#1046)。PR#99:通常の警告の指示を参照してください。これは、それらの異常なCSSクラス(警告-別の参照)、不一致LaTeX警告タイトル(“参照”ではなく“参照”を参照)、およびテキスト構築器内の偽のインデントを除去する。
HTML構築器
#783:画像が幅または高さでスケーリングされている場合、フルサイズの画像へのリンクを作成してください。
#1067:JavaScript検索結果のランキングを改善する:タイトルの一致が全文マッチングの前にランクされており、オブジェクト結果の分類が良い。プラグ対応可能な検索スコアレータも実現されている。
#1053:“右側のバー”と“折り畳み可能なサイドバー”のHTMLトピック·オプションは、現在一緒に使用可能です。
JQuery 1.7.1およびUnderscore.js 1.3.1に更新します。
テクスチャ情報構築器
エントリがない場合には、“Index”ノードは追加されません。
“deffn”カテゴリに大文字が含まれていれば、もう大文字ではありません。
desc_annotation
ノードをレンダリングします。strong
そしてemphasis
ノードの現在のフォーマットは以下のとおりである.literal
s。これは標準的なTexinfoタグが (*strong*
そして_emphasis_
)は、一般にこれらの構造がパラメータ名を記録するために使用されるので、混乱した出力をもたらす。フィールドリストフォーマットは、“情報フィールドリスト”をより良く表示するように調整されている。
system_message
そしてproblematic
現在,ノードのフォーマット設定方式はテキスト構築器の設定方式と類似している.Optionコマンド署名ではハイフンの“en-dash”と“em-dash”変換を実行しない.
@ref
今では使われていません@pxref
交差引用に用い,リンク前に単語“See”を付加することを防ぐ(情報出力に影響を与えない).♪the
@finalout
より良いTeX出力を得るためにコマンドが追加されました。transition
ノードは現在,星番号(“*”)ではなく下線(“_”)を用いてフォーマットされている.属性のデフォルト値
paragraphindent
2から0に変更されましたが、これは、段落がデフォルトで引っ込めなくなったことを意味します。#1110:新しい構成値
texinfo_no_detailmenu
存在するかどうかを制御するために追加されました@detailmenu
“Top”ノードのメニューに追加します。“Top”ノードを除いて、詳細なメニューは作成されません。
重複したドメインインデックスを修復することは,無効出力の問題となる.
ラテックス製造業者:
PR#115:追加
'transition'
中のプロジェクトlatex_elements
カスタムトランジションのための表示方式.ジェフ·クルーカスのおかげですPR#114:LaTeXコンパイラは、デフォルトで“cmap”パッケージを含むようになりました。♪the
'cmappkg'
中のプロジェクトlatex_elements
このような状況を制御するために使うことができる。ドミトリー·シャヘネフのおかげです♪the
'fontpkg'
中のプロジェクトlatex_elements
今は黙認している''
当たるlanguage
シリル文字を使います。ドミトリー·シャフネフが提案しましたThe
latex_documents
,texinfo_documents
, andman_pages
configuration values will be set to default values based on themaster_doc
if not explicitly set inconf.py
. Previously, if these values were not set, no output would be generated by their respective builders.
国際化:
カスタムテンプレートにI 18 N機能を追加します。たとえば,docディレクトリのSphinx参照文書は提供される.
sphinx.pot
以下の位置からのメッセージ文字列を含むファイルdoc/_templates/*.html
使用時make gettext
それがそうです。PR#61,#703:非ASCIIファイル名処理のサポートを追加します。
他の建築業者:
DocutilsネイティブXMLと擬似XMLビルダを追加した.見
XMLBuilder
そしてPseudoXMLBuilder
それがそうです。PR#45:Linkcheckビルダをチェックします。
#anchor
生きるためです。PR#123、#1106:追加
epub_use_index
値を配置する。提供すればそれは使用されますhtml_use_index
Epub建築業者のために用意されています。PR#126:追加
epub_tocscope
値を配置する。この設定はepub TOCの生成を制御する.ユーザはまた、隠れたTOCエントリを含むことができる。PR#112:追加
epub_show_urls
値を配置する。
内線:
PR#52:
special_members
自動ドッキングのマークの現在の行動は以下の通りですmembers
それがそうです。PR#47:追加
sphinx.ext.linkcode
延期する。PR#25:継承図において,クラスdocstringの1行目は現在クラスのツール提示である.
コマンドラインインタフェース:
PR#75:追加
--follow-links
ライオンの顔像の選択肢-apidoc。#869:ライオンの顔像-Buildは現在選択可能
-T
未処理の例外の後に完全なバックトラックを印刷するために使用される。Sphinx-Buildは現在この基準をサポートしています
--help
そして--version
選択します。ここで、無効なオプションまたはパラメータを使用してSphinx−Buildを呼び出す場合、それは、より具体的なエラーメッセージを提供する。
Sphinx-Buildには詳細な選択肢があります
-v
より良い効果を得るために再使用することができる。個々のイベントが提供する出力は通常の場合よりやや多い.このオプションが2回以上出現すると、より詳細な出力が提供され、デバッグに有用である可能性があります。
エリア設定:
広報74:ロシア語の翻訳を修正します。
PR#54:ノルウェー語Bokmaal翻訳を追加します。
PR#35:スロバキア語翻訳が追加されました。
PR#28:ハンガリー語翻訳が追加されました。
#1113:ヘブライ語領域設定を追加します。
#1097:バスク地域を追加します。
#1037:ポーランド語翻訳におけるタイピングミスを修復します。ジェイコブ·ウィルクのおかげです
#1012:エストニア語の翻訳を更新します。
最適化:
単語語幹ルーチンの結果をキャッシュすることで,検索インデックスの構築速度を速める.Pythonドキュメントを構築する際に約20秒節約できます。
PR#108:新しい
sphinx-build -j
選択します。
書類¶
PR#88:“Sphinx開発者ガイド”の追加 (
doc/devguide.rst
)の中で,ライオンの顔画像プロジェクトの基本的な開発フローについて概説した。詳細な“Sphinxのインストール”ドキュメントを追加しました (
doc/install.rst
)。
誤りを修正する¶
PR#124:バージョン変更中の固定段落は、宙に浮いた段落がない場合に無視される。修復エラーのhtml出力(ネスト
<p>
ラベル)。FIX VersionModifiedは翻訳不可能である.金のおかげです。PR#111:継承メンバが設定されていても、add_autoc_attrgetter()を守る。A·ジェシー·ジル·デイビスに感謝します
PR#97:翻訳文書中の脚注処理を修復する.
テキストライタが図形コマンドの内容を扱うことができないVISTICE_LENGUGEの問題を修正した.
テキスト生成器が幅/全角文字をサポートしていない問題:見出し下線幅,フォームレイアウト幅,テキストサラウンド幅を修正した.
LaTeXテーブルの見出しブロック格中の先頭スペースを修復する.
#1132:最初の列の複数行のセルのラテックステーブル出力を修復します。
#1128:非標準領域を使用してタイム文字列をフォーマットしようと試みたときに発生したUnicodeエラーを修復します。
#1127:autocを修復非Pythonファイルをマーク化する際のバックトラックを試みます。
#1126:LaTeXのエラー位置(コマンドラインオプション名のような)の2ハイフンから短い下線への変換を修復します。
#1123:指定されたファイル名にスペースを使用することを許可する
literalinclude
それがそうです。#1120:ライオンのイメージに内蔵されているトピック“Basic”、“haiku”、“Scrols”にi 18 nの改善を追加しました。レオナルド·J·カバレロ·Gに感謝します
#1118:スペイン語の翻訳が更新されました。レオナルド·J·カバレロ·Gに感謝します
#1117:sphinx-apidocで.pyxファイルを処理します。
#1112:異なる方法(絶対/相対)で文書から参照される場合、ファイルの重複ダウンロードを避ける。
#1111:検索で大文字の単語を検索できない問題を修復する
html_search_language
“ja”です。斎藤友夫のおかげです。#1108:テキストライタは、非デフォルト開始値(Ewan Edwardsベースのパッチ)を使用して、列挙リストを正しく番号付けすることができます。
#1102:autodocのマルチコンテキスト“with”文をサポートします。
#1090:gettextがタームリスト用語を抽出していない問題を修復します。
#1074:生成された検索インデックスに環境バージョン情報を追加して、古いバージョンとの互換性の問題を回避します。
#1070:Python 3を実行する際に非酸洗の問題が発生することを回避し、保存されている環境はPython 2で作成されます。
#1069:autocを修復し、キーワードパラメータを持たない“Partial”関数署名時に生じるエラー(ArturGasparパッチ)のフォーマットを試みました。
#1062:sphinx.ext.autocを使用する __init__ クラス署名のメソッド署名.
#1055:ソースディレクトリの相対パスを使用してWebサポートを修復します。
#1043:ライオンのイメージの修復-クイックスタート再質問Yes/No、なぜなら
input()
Python 3.2.0+Windowsで追加の‘r’を持つ値を返します。Régis DéCampsのおかげです。#1041:CPPドメイン解析器が修飾子解析定数タイプを使用できない問題を修復します。
#1038:CPPドメイン解析器がC+11“static conexpr”宣言の問題を解析できないことを修復します。ジェイコブ·ウィルクのおかげです
#1029:修復マッピングにPython 3.3を使用して複数のキー/値が設定されている場合、intersphinx_maping値が不安定であるという問題があります。
#1028:修復テキスト生成器内のラインブロック出力。
#1024:Sphinxが見つからない場合、Makefile/make.batエラーメッセージが改善されます。Anatoly Techtonikのおかげです。
#1018:テキスト生成器内の“CONTAINER”命令処理を修復します。
#1015:JavaScriptのjQuery CONTAINS()の書き換えを停止します。
#1010:デフォルトでpngath画像を透明にします。IE 7+は処理できるはずです。
#1008:Python 3.3を使用した修復テストに失敗しました。
#995:LaTeX“HOWTO”コースのディレクトリとページ番号を修復します。
#976:gettextを修復してインデックス項目を抽出しません。
PR#72:#975:docutils 0.10の前にgettextが定義タームを抽出していない問題が修復されました。
#961:修復コード片の三重引用符のLaTeX出力。
#958:保留しないでください
environment.pickle
一度失敗した構築の後。#955:I 18 N変換を修復します。
#940:gettextを修復してグラフィックス·タイトルを抽出しません。
#920:導入が許可されているPILパッケージの修復問題
Image
PIL命名空間はない。マーク·シュライシーのおかげです#723:WebKitベースのブラウザのローカルファイルの検索機能を修復します。
#440:いくつかのファイルシステムにおいてエラーが生成された古いファイルリストの粗いタイムスタンプ解析を修復します。
バージョン1.1.3(2012年3月10日)¶
広報#40:修復
safe_repr
関数は、非ASCII文字を含むバイト文字列を正しく復号する。PR#37:sphinx-apidocの構成を許可する
SPHINX_APIDOC_OPTIONS
それがそうです。PR#34:Python 2.4互換性を回復します。
PR#36:Documentクラス固有のLaTeX出力で“書目-ディレクトリ”を修復します。
#695:表示言語“python”を強調するように明示的に指定されている場合、非Pythonコードセグメントを識別するためにコードを解析しようとしないでください。
#859:リンクする適切なオブジェクトが見つからない場合がある場合に発生した例外を修復します。
#860:無効なdoctest例に遭遇した場合は崩壊せず,警告を発するだけでよい.
#864:いくつかの設定を使用してクラッシュを修復します。
modindex_common_prefix
それがそうです。#862:修復処理
-D
そして-A
Python 3のオプションです。#851:再帰的エラーではなく、再帰的ディレクトリツリーを識別して警告します。
#853:docutilsバックボーンとの互換性を回復します。
#852:HtmlHelpインデックスエントリリンクを再修復します。
#854:内蔵にプロパティエラーが発生したINTERVICATION_DUTRAGEを修復します。
#832:語彙表に注釈または個々の用語を追加した場合の崩壊を修復します。
#834,#818:Sphinxがサポートするすべての言語のHTMLヘルプ言語/コード化マッピングを修復します。
#844:doctest拡張でUnicode出力を処理する際に生じる崩壊を修復します。
#831:プロビジョニング
--project
SETUP_COMMANDに通知されたフラグです。#875:Python 3でプロファイルを読み込む問題が修復されました。
#876:Python 3でのクイックスタートテストを修復します。
#870:文書削除時に出現した偽のKeyErrorを修復します。
#892:サブディレクトリ内のマスター文書に対する単一のHTMLビルダの誤った挙動を修復します。
#873:アサートエラーを空で修復
only
指令する。#816:Qtの修復は、ビルダ内の符号化問題を修復します。
Release 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サポートなしでintersphinxを正常に動作させる。
#805:ジャン
Sphinx.add_index_to_domain
方法は正常に動作した。#780:Python 2.5互換性を修復します。
バージョン1.1(2011年10月9日)¶
互換性のない変更¶
♪the
py:module
命令は出力しませんplatform
オプション価値はもうありません。(これはこの指示が唯一出力した内容であるため,非常に一致しない.旧依存項バージョンのサポートを削除しました。現在の要求は:
Pygments>=1.2
Docutils>=0.7
金佳2>=2.3
追加された機能¶
Python 3.xに対するサポートを追加しました。
新しい建設業者とサブシステム:
テクスチャ情報生成器を追加しました
コンテンツに対するI 18 Nサポートを追加しました
gettext
建設業者や関連公共事業会社です追加
websupport
図書館と建築業者です。#98:追加されました
sphinx-apidoc
ソースファイル階層構造を自動生成するスクリプトには,モジュールとパケットを記録するためのautoc命令が含まれている.#273:英語以外の言語全文検索をサポートするインタフェースを追加します。日本語へのサポートを追加します。
マーク:
#138:1を追加
index
役割は内部連結引用項を作成する。#454:より多くのインデックスタグ付け機能が追加されている:タグSee/See Alsoエントリと、所与のキーのMainエントリと。
#460:使用を許可する
toctree
のnumbered
選択します。#586:改善の実施
glossary
各定義に複数の用語のタグがあることを許す.#478:新規
py:decorator
装飾者を説明するように指示された。C++ドメインは現在配列定義をサポートしています。
C++ドメインは現在、文書フィールドをサポートしています (
:param x:
内部指令)。部分見出しは
only
指示はもう正しく処理されることができる。増列する.
emphasize-lines
ソースコードコマンドのオプション。#678:C++ドメインは、スーパークラスをサポートしています。
HTML生成器:
増列する.
pyramid
テーマです。#559:
html_add_permalinks
現在は文字列であり,固定リンクで表示されるテキストを提供する.#259:HTMLフォーム行には、“シマウマスタイル”を有効にするために偶数/奇数のCSSクラスがあります。
#554:トピック·オプションの追加
sidebarwidth
基本的なテーマに切り込む。
他の建築業者:
#516:新たな価値の増加
latex_show_urls
オプションは脚注にURLが表示されます。#209:新規
text_newlines
そしてtext_sectionchars
値を配置する。増列する.
man_show_urls
値を配置する。#472:LinkCheck Builder:リンクを並列にチェックし、HTTP Head要求を使用してタイムアウトを構成することを許可します。新しい構成値:
linkcheck_timeout
そしてlinkcheck_workers
それがそうです。#521:新規インストール
linkcheck_ignore
値を配置する。#28:LaTeXビルダでは、テーブル内の行/列スパンをサポートします。
構成とスケーラビリティ:
#537:新規
nitpick_ignore
それがそうです。#306:新規
env-get-outdated
事件。Application.add_stylesheet()
現在完全なURIを受け付けています。
自動ドッキング:
#564:追加
autodoc_docstring_signature
それがそうです。有効化後(デフォルト設定),autocは文書文字列の1行目から署名を検索する(そこに署名が見つかった場合).#176:プロビジョニング
private-members
Autodocコマンドのオプション。#520:プロビジョニング
special-members
Autodocコマンドのオプション。#431:属性のドキュメント注釈は、割り当てと同じ行に位置するようになりました。
#437:autodocには、クラスデータ属性値が表示されます。
Autodocは現在記録をサポートしています
functools.partial
物体です。
その他の拡張:
追加
sphinx.ext.mathjax
延期する。#443:外部Graphvizファイルの参照を許可します。
増列する.
inline
オプションはraphviz命令に追加され、LaTeX出力のデフォルト設定(ブロックスタイル)が修復されます。#590:新規
caption
Graphvizコマンドのオプション。#553:新規
testcleanup
Doctest拡張中のブロック。#594:
trim_doctest_flags
今も削除しました<BLANKLINE>
指標です。#367:継承マップには、隠れたメンバを自動的に排除する機能が追加され、機能を選択的に有効にするオプションが提供されます。
増列する.
pngmath_add_tooltips
それがそうです。数学的拡張displayathコマンドは現在サポートされています
name
他にはlabel
公式にラベルを貼って、Docutilsと互換性があります。
新しいエリア設定:
#221:スウェーデン語領域設定を追加します。
#526:イラン地域が追加されました。
#694:ラトビア言語環境が追加されました。
ネパール語地域設定が追加されました。
#714:韓国語領域設定が追加されています。
#766:エストニア語領域設定が追加されています。
修復されました
#778:検索リンクを介したページ上の“検索一致隠しリンク”リンクを修復します。
“viewcode”拡張参照のソース位置を修復します。
バージョン1.0.8(2011年9月23日)¶
#627:自動集約生成中のAttributeErrorバックトラックを修復します。
直して。
abbr
略語には改行の時の役割があります。#727:カスタムオブジェクトタイプを使用して検索結果へのリンクを修復します。
#648:未定義参照に関する警告のレポートの行番号を修復します。
#696、#666:タイプ名ではないC++配列定義およびテンプレートパラメータを修復します。
#633:LaTeX出力では、節ヘッダに脚注が許可されています。
#616:intersphinxを介したキーワードのリンクを許可します。
#613:生産リストトークン名にUnicode文字を使用することができます。
#720:テキストおよびMANのGraphvizノードに仮想訪問者を追加します。
#704:ミラーファイルのコピーエラーを修復します。
#677:C++ドメイン内の複数の署名の解析を修復します。
#637:ソースファイルを検索する際には、Emacsロックファイルを無視します。
#544:Autodocにモジュールを導入可能な.pyw拡張子を許可します。
#700:使用
$(MAKE)
クイック入門で生成されたMakefileにあります。#734:サイドバー検索ボックス幅をブラウザで一致させます。
#644:HTML出力の中央パターンの間隔を修復します。
#767:sys.stderrにSphinxErrorメッセージを印刷すると、セキュリティコードされます。
#611:チャプタがないがリンク先の文書を修復するLaTeX出力エラー。
内蔵メソッド記述子を正しくautodoc内のメソッドと見なす.
#706:monkeypatingPython textwrapモジュールを停止します。
#657:Viewcodeでは、ASCII符号化されていないソースファイルを正しく処理することができます。
#669:尊重
noindex
Py:モジュール命令中のフラグオプション.#675:存在しない行を含むインデックスエラーを修復する
literalinclude
それがそうです。#676:カスタム関数/メソッドパラメータ区切り文字列に準拠します。
#682:JSとjQuery>=1.5互換性がありません。
#693:HTMLHelp.hhkファイルを作成する際に発生する二重コードを修復します。
#647:解析された文字ブロックにスマートタイプを適用しないでください。
C++ドメインは現在配列定義をサポートしています。
バージョン1.0.7(2011年1月15日)¶
#347:自動集約における静的メソッド命令のエラー生成を修復します。
#599:PILのインポート
from PIL import Image
それがそうです。#558:LaTeX出力のタイトル付きロングテーブルを修復します。
タグをLaTeX出力に参照させて再びハイパーリンクとして動作させる.
#572:参照タグが見つからない場合、デフォルトで警告が表示されます。
#536:難癖モードで参照目標が不足していると文句を言う場合には行番号が含まれています。
#590:LaTeX出力のGraphvizグラフの内部接続表示を修復します。
#589:インストールコマンドでapp.build()を使用して生成されます。
継承グラフ異常の1つのエラーを修復し、このエラーは、ベースクラスのうちの1つが内蔵されている場合にスキップされる。
C++ドメインオブジェクトの通常のインデックスリンクを修復します。
#332:LaTeX出力内の警告境界を可視化します。
#573:ファイル削除後の再構成時に発生したKeyErrorを修復します。
グローバルディレクトリ木付きファイルを削除する際のバックトラック問題を修復した.
Autodocオブジェクトを導入できない場合は,つねに次回生成時にコマンドを含む文書を読み返してください.
Autodocオブジェクトを導入できなければ,導入誤りの完全バックトラックを示す.
ファイルのダウンロードや画像削除が注目されていないエラーを修復します。
#571:実施
~
Cドメインの交差参照プレフィックス.#556を用いてラテックス収量の回帰を修復した。
#568:記述子のクラス属性文書の検索が修復され、注釈文書が使用可能になりました。
バックトラック問題を修復する
only
指示の前に目標がある。重複するC++ドメインオブジェクトで発生するバックトラックを修復する.
オブジェクト指向JavaScriptドメインリンクの修復を用いる.
$
彼らの名で。
バージョン1.0.6(2011年1月4日)¶
#581:Pythonドメインの空交差参照オブジェクトのバックトラックを修復します。
#283:Chromeブラウザ上の文字ブロック表示の問題を修復します。
#383、#148:汎用索引および語彙表の限られた範囲のアクセント文字の順位付けをサポートします。
#570:復号を試みる
-D
そして-A
領域を使用して優先符号化のコマンドラインパラメータを設定する。#528:観察
locale_dirs
JS翻訳ファイルを探しています。#574:LaTeXビルダに日本語ドキュメントをより良くサポートするための特別なコードを追加します。
回帰#77:1つのパラメータしか与えられていなければ
:param:
タグ付け時には,アイテム記号列が再び埋め込まれて表現される.#556:LaTeX出力に欠落しているパラグラフ区切りを修復する場合があります。
#567:送信
autodoc-process-docstring
イベントは,文書文字列を持たないオブジェクトに対しても,コンテンツを追加できるようにする.#565:LaTeXビルダでは、文字ブロックが異なるテーブル処理を必要とするだけでなく、他の類似リストのブロック要素もかなり多い。
#515:有効な署名がないPythonオブジェクトのビューコード拡張のバックトラックを修復します。
Autocに含まれる文書文字列から生成される警告行番号の奇妙なレポートを修復するのは,docutilsバージョンによって振舞いが異なるためである.
C++ドメインに対するいくつかの修復.
バージョン1.0.5(2010年11月12日)¶
#557:整列された画像および図面にdocutils 0.7を追加するために必要なCSSスタイル。
LaTeX出力で生成されたMakefileでは、CLEAN上のpdfファイルを削除しないでください。それらは必要な画像である可能性があります。
#535:ラインブロックのために生成されたLaTeX出力を修復します。
#544:許可
.pyw
ソースファイル拡張子として.
バージョン1.0.4(2010年9月17日)¶
#524:バージョン2がzlib圧縮データを含むので、Windows上でバイナリモードでintersphinxリストを開く。
#513:JSMath拡張子のような非ローカルURIをJavaScriptファイルに提供することができます。
#512:次のバックトラックを修復
intersphinx_mapping
空です。
バージョン1.0.3(2010年8月23日)¶
#495:Docutilsディレクトリからのリンクの内部リンクと外部リンクの違いを修復します。
#494:修復
maxdepth
オプション、使用するtoctree()
一緒に使用する場合はテンプレートを呼び出すことができますcollapse=True
それがそうです。#507:文字列テキストに四角括弧を含むPythonパラメータリスト解析クラッシュ問題を修復します。
#501:タイトルのない図形を持つLaex文書を構築する際の回帰問題.
#510:ピックアップ不可能なクラスを修復するための継承マップ。
#497:サイドバー折り畳みボタンに個別の背景色を導入し、見やすくします。
#502、#503、#496:いくつかの内蔵トピックの小さなレイアウトエラーを修復します。
バージョン1.0.2(2010年8月14日)¶
#490:追加されたタイプのオブジェクトへの交差参照を修復する
add_object_type()
インターフェース関数。異なる命令タイプの文書フィールドタイプの処理が修復された。
長い署名を中断し、逆回転変換子の使用を継続することを可能にする。
修復Cドメインは不要なパターンを参照する(名前空間がPygmentsスタイルと衝突するため).
明示的なアンカを有するPEPおよびRFCの参照を可能にする。
#471:図面へのLaTeX参照を修復します。
#482:非正確な検索を実行する場合、所与のタイプのオブジェクトのみを一致させてください。
#481:以下のコマンドを使用して、Python参照ターゲットに非正確な検索を適用します。
.name
モジュールについても同様である.#484:情報フィールドリストのパラメータをコピーする際に発生したクラッシュを修復します。
#487:リペアにデフォルトのロールを設定する
oldcmarkup
延期する。#488:json-pyのインストール時の崩壊を修復し、1つを提供します。
json
モジュールは,simplejsonと互換性がない.#480:Intersphinxにおけるターゲットの名前を修復する処理。
#486:削除の修復
!
すべての交差引用役に用いられる.
バージョン1.0.1(2010年7月27日)¶
#470:RESTドメインオブジェクトのために生成されたターゲット名が修復され、同じ名前空間にはありません。
#266:ベンガル語を追加します。
#473:JavaScriptオブジェクト名を解析する際のエラーを修復します。
#474:toctreeがない場合はSingleHTMLBuilderを使用して構築を修復します。
明示的なオブジェクトを持つintersphinxでリンクされたオブジェクトの表示名を修復する.
JSON構築器を用いて構築を修復した。
LaTeXのオブジェクト記述における超参照を修復する.
バージョン1.0(2010年7月23日)¶
互換性のない変更¶
ドメインへのサポートを追加しました。ドメインは、一緒に属するオブジェクトを記述するすべての命令およびロールの集合、例えばプログラミング言語の要素である。いくつかの内部ドメインを提供しています
巨漢.
C
C+
JavaScript
RedTextを再構築する
C命令を定義してリンクするための古いタグは現在使用されていない.活性化しなければ、将来のバージョンでは機能しなくなるだろう
oldcmarkup
Extension;Sphinx 1.0では、デフォルトでアクティブ状態にあります。旧依存項バージョンのサポートを削除しました。現在の要求は:
Docutils>=0.5
金佳2>=2.2
使用が推奨されていない要素を削除しました:
exclude_dirs
配置値sphinx.builder
モジュール
追加された機能¶
普通:
すべての不足している参照を警告する“難癖”モードが追加された。それは
sphinx-build -n
命令行スイッチまたはnitpicky
値を配置する。増列する.
latexpdf
Makefileの目標を迅速に導入する。
マーク:
♪the
menuselection
そしてguilabel
キャラクターは今与号加速器を支持しています。新しいよりコンパクトな文書フィールド文法を識別することができます:
:param type name: description
それがそうです。増列する.
tab-width
選択権.literalinclude
指令する。増列する.
titlesonly
選択権.toctree
指令する。追加
prepend
そしてappend
オプションを追加しますliteralinclude
指令する。#284:すべてのdocinfoメタデータは、著者だけではなく、ドキュメントメタデータに格納されています。
♪the
ref
役割は今もタイトル順に表を引用することができます。♪the include 指示はもう絶対経路をサポートしており、それはソースディレクトリに対して解釈されている。
Pythonドメインではこのような引用は
:func:`.name
直接一致する名前が見つからない場合は、`今、任意のプレフィックスを有する一致する名前を検索します。
構成:
増列する.
rst_prolog
値を配置する。増列する.
html_secnumber_suffix
節番号フォーマットの配置値を制御する.増列する.
html_compact_lists
Docutilのダウンサイジングリスト機能を制御するための構成値.♪the
html_sidebars
構成値は、キーとしてモードを含むことができ、値は、どのサイドバーテンプレートを提示すべきかを明示的に選択するリストとすることができる。これは,内蔵サイドバーの内容が選択的にしか含まれていないことを意味する.html_static_path
今は、単一のファイルエントリを含むことができます。The new universal config value
exclude_patterns
makes the oldunused_docs
,exclude_trees
andexclude_dirnames
obsolete.増列する.
html_output_encoding
値を配置する。追加
latex_docclass
値を構成し、“toside”文書クラスオプションを“one”でカバーできるようにします。追加
trim_doctest_flags
配置値は,デフォルトの場合trueである.増列する.
html_show_copyright
値を配置する。増列する.
latex_show_pagerefs
そしてlatex_show_urls
値を配置する。の行為です。
html_file_suffix
少し変更:空文字列は現在“デフォルト接尾辞”ではなく“無接尾辞”を表していますので、使用してくださいNone
“デフォルト接尾辞”を表す
新しい建築業者:
Epub形式のビルダを追加した.
マニュアルページを追加した生成器。
単一ファイルHTML生成器を追加した.
HTML出力:
ネイティブキャラクターは現在、その名前を持つCSSクラスを獲得し、スタイルがその外観をカスタマイズすることを許可している。ドメインに特化したキャラクターには2つの種類があります
domain
そしてdomain-rolename
それがそうです。現在クラスを取得しています
internal
もしそれらがプロジェクト全体の内部にある場合、現在のページの内部ではない。外部参照の仕様は新しいものとすることができる
externalrefs
デフォルトトピックのトピックオプション。デフォルトのテーマでは、今は新しいものを使用してみることができます
collapsiblesidebar
テーマオプション。#129:Toctreeは現在1つにパッケージされています
div
クラスマークを使うtoctree-wrapper
HTML出力では♪the
toctree
テンプレートのCallableは現在1つありますmaxdepth
キーワードパラメータは,生成される木の深さを制御する.♪the
toctree
テンプレート中のCallableは現在受け入れていますtitles_only
キーワードパラメータ。増列する.
htmltitle
レイアウトテンプレート中のブロック.JavaScript検索では、モジュール名を含むオブジェクト名を検索することができます。
sys.argv
それがそうです。新しいテーマを追加しました
haiku
ハワイ語OSユーザーガイドからインスピレーションを得ました。新しいテーマを追加しました
nature
それがそうです。新しいテーマを追加しました
agogo
著者:Andi Albrecht。新しいテーマを追加しました
scrolls
作者:Armin Ronacher。#193:1つ追加
visitedlinkcolor
“トピック”オプションは、デフォルトのトピックに設定されています。#322:検索インデックスを非同期的にロードすることにより、検索ページの応答性が向上します。
拡張インタフェース:
増列する.
html-collect-pages
それがそうです。増列する.
needs_sphinx
配置値とrequire_sphinx()
アプリケーションAPIメソッド。#200:新規
add_stylesheet()
アプリケーションAPIメソッド。
内線:
追加
viewcode
延期する。追加
extlinks
延期する。Autodocにおけるメンバのソース順序付けのサポートを追加しました。
autodoc_member_order = 'bysource'
それがそうです。増列する.
autodoc_default_flags
設定値は、すべてのautoc命令のデフォルトフラグを選択するために使用することができます。Intersphinxには,他の項目における命名ラベルを引用し,リンクする項目を指定する方法が付加されている.
#280:Autodoc割り当てられたインスタンス属性を記録することができるようになりました。
__init__
方法です。多くの改善と修復があります
autosummary
延期されたのは、ポーリー·ヴェルタニンのおかげです。#309:
graphviz
ExtensionはPNG画像ではなくSVGを出力することができますgraphviz_output_format
値を配置する。増列する.
alt
選択権.graphviz
指示を拡張する。増列する.
exclude
はいの論点です。autodoc.between()
それがそうです。
日语原文:
Bojan Mihelaさんのおかげで、クロデア語翻訳が増加した。
トルコ語の翻訳が追加されたが、これはFirat Ozgulのおかげだ。
ポール·フェルナンデスのおかげでカタロニア語の翻訳が増えました
簡体字中国語翻訳を新設する。
ホス·ラーソンのおかげでデンマーク語の翻訳が増えました
Dalius Dobravolskasのおかげでリトアニア語の翻訳が増えた。
修復されました
#445:生成されたHTMLを用いた検索機能を用いた場合,結果ページへのリンクを修復する.
dirhtml
建築業者です。#444:テンプレートでは、“striptag”JJJAフィルタ処理の値を正しく再変換します。