建設者.

これらはライオンの顔画像構築器を内蔵していますより多くの構築器を以下のように追加することができる extensions それがそうです。

建造者の“名称”は必ず与えられなければならない -b コマンドラインオプション sphinx-build 建造者を選択する場合は、以下の操作を実行してください。

class sphinx.builders.html.StandaloneHTMLBuilder

これは標準的なHTML構築器である.その出力は、スタイルテーブルおよびオプションのRESTソースコードを含むHTMLファイルを含むディレクトリである。このビルダの出力をカスタマイズできる構成値がかなりありますので、1章を参照してください HTML出力用オプション もっと細かいことを知っています。

name = 'html'

format = 'html'

supported_image_types = ['image/svg+xml', 'image/png', 'image/gif', 'image/jpeg']

class sphinx.builders.dirhtml.DirectoryHTMLBuilder

これは標準HTMLビルダのサブクラスである.その出力はHTMLファイルを含むディレクトリであり，各ファイルが呼び出される. index.html そのページ名と同名のサブディレクトリに置かれる.例えば文書は markup/rest.rst 出力ファイルは生成されません markup/rest.html しかし、しかし markup/rest/index.html それがそうです。ページ間にリンクを生成する際には， index.html 省略されているので，URLは以下のようになる. markup/rest/ それがそうです。

name = 'dirhtml'

format = 'html'

supported_image_types = ['image/svg+xml', 'image/png', 'image/gif', 'image/jpeg']

バージョン 0.6 で追加.

class sphinx.builders.singlehtml.SingleFileHTMLBuilder

これは、項目全体を出力ファイルに統合するHTML構築器である。(明らかに、これは小さいプロジェクトにしか適用されません。)このファイルの名前は、メインドキュメントと類似している。インデックスは何も生成されない.

name = 'singlehtml'

format = 'html'

supported_image_types = ['image/svg+xml', 'image/png', 'image/gif', 'image/jpeg']

バージョン 1.0 で追加.

class sphinxcontrib.htmlhelp.HTMLHelpBuilder

この生成器は独立HTML生成器と同様の出力を生成するが，HTMLヘルプ支援ファイルも生成し，Microsoft HTMLヘルプスタジオがCHMファイルにコンパイルできるようにする.

name = 'htmlhelp'

format = 'html'

supported_image_types = ['image/png', 'image/gif', 'image/jpeg']

class sphinxcontrib.qthelp.QtHelpBuilder

このビルダは独立したHTMLビルダと同様の出力を生成するが，生成される. Qt help Qt集合生成器がそれらの集合サポートファイルをコンパイルすることを許可する.

バージョン 2.0 で変更: Sphinx.buildersパケットからsphinxcontri.qthelpに移動する.

name = 'qthelp'

format = 'html'

supported_image_types = ['image/svg+xml', 'image/png', 'image/gif', 'image/jpeg']

class sphinxcontrib.applehelp.AppleHelpBuilder

このビルダは，独立HTMLビルダと同様の出力に基づいてApple Help Bookを生成する.

ソースディレクトリに何かが含まれていれば .lproj フォルダのうち，選択された言語に対応するフォルダの内容は，生成された出力とマージされる.他のすべての文書タイプはこのフォルダを無視するだろう。

有効なヘルプマニュアルを生成するためには，この構築器にはコマンドツールが必要である. hiutil Mac OS X 10.6以降でのみ利用可能です。インデックスを無効にするステップを設定することで applehelp_disable_external_tools 至る True この場合，出力は有効ではない. hiutil すでにすべてにある .lproj バッグの中のファイルを束ねる。

name = 'applehelp'

format = 'html'

supported_image_types = ['image/png', 'image/gif', 'image/jpeg', 'image/tiff', 'image/jp2', 'image/svg+xml']

バージョン 1.3 で追加.

バージョン 2.0 で変更: Sphinx.buildersパケットからsphinxcontri.applehelpに移動する.

class sphinxcontrib.devhelp.DevhelpBuilder

このビルダは独立したHTMLビルダと同様の出力を生成するが，生成される. GNOME Devhelp GNOME Devhelpリーダーがサポートファイルを表示することを可能にします。

name = 'devhelp'

format = 'html'

supported_image_types = ['image/png', 'image/gif', 'image/jpeg']

バージョン 2.0 で変更: Sphinx.buildersパケットからsphinxcontri.devhelpに移動する.

class sphinx.builders.epub3.Epub3Builder

この生成器は独立HTML生成器と同じ出力を生成するが，生成する. epub 電子書籍読者に適用される文書。見 EPub情報 それについての詳細な情報。Epubフォーマットの定義については、ご確認ください http://idpf.org/epub あるいは…。 https://en.wikipedia.org/wiki/EPUB それがそうです。創造者は EPub 3 ファイルです。

name = 'epub'

format = 'html'

supported_image_types = ['image/svg+xml', 'image/png', 'image/gif', 'image/jpeg']

バージョン 1.4 で追加.

バージョン 1.5 で変更: EPUB 3ビルダは、Sphinx−1.5からepubのデフォルトビルダとして使用される。

class sphinx.builders.latex.LaTeXBuilder

このビルダは、出力ディレクトリにLaTeXファイルのセットを生成する。属性は、どの文書がどのLaTeXファイルに含まれるかを指定します。 latex_documents 値を配置する。このビルダの出力をカスタマイズできる構成値がいくつかありますので、1章を参照してください LaTeX出力オプション もっと細かいことを知っています。

生成されたLaTeXファイルは、“最小”TeX配信インストールには存在しない可能性があるいくつかのLaTeXパケットを使用する。

Ubuntu Xenialでは、PDFの構築に成功するためには、以下のパッケージをインストールする必要があります。

• texlive-latex-recommended

• texlive-fonts-recommended

• texlive-latex-extra

• latexmk (これはGNU/LinuxおよびMacOS X上のSphinx要件です make latexpdf ）

場合によっては追加のソフトウェアパッケージが必要です(参照 'fontpkg' のキーワードです。 latex_elements より多くの情報については、以下の操作を実行してください)。

• to support occasional Cyrillic letters or words, and a fortiori if language is set to a Cyrillic language, the package texlive-lang-cyrillic is required, and, with unmodified 'fontpkg', also cm-super or cm-super-minimal,

• to support occasional Greek letters or words (in text, not in math directive contents), texlive-lang-greek is required, and, with unmodified 'fontpkg', also cm-super or cm-super-minimal,

• for 'xelatex' or 'lualatex' (see latex_engine), texlive-xetex resp. texlive-luatex, and, if leaving unchanged 'fontpkg', fonts-freefont-otf.

Sphinx LaTeXのテストはUbuntu Xenial上で行われ、そのTeX分布は2016年3月のTeXLive 2015スナップショットに基づいている。

バージョン 1.6 で変更: 従来，テストはUbuntu Precision(TeXLive 2009)上で行われていた.

バージョン 2.0 で変更: 従来，テストはUbuntu Trusted(TeXLive 2013)上で行われていた.

注釈

1.6から始めて make latexpdf 用途 latexmk (Windows上ではありません)。これにより，自動実行に必要な実行回数を確保し，交差引用，ブックマーク，インデックス，ディレクトリを正確に取得することができる.

一人で届くことができます latexmk オプションが通過する LATEXMKOPTS Makefile変数。例：

make latexpdf LATEXMKOPTS="-silent"

コンソール出力を最小にする.

またもし latexmk バージョン4.52 b以降(2017年1月) LATEXMKOPTS="-xelatex" 大量の図形を含む場合には，XeLateXによりPDF構築を加速する.

選択肢を直接伝える (pdf|xe|lua)latex バイナリ、変数を使用する LATEXOPTS 例えば、：

make latexpdf LATEXOPTS="--halt-on-error"

name = 'latex'

format = 'latex'

supported_image_types = ['application/pdf', 'image/png', 'image/jpeg']

直接PDF構築器が提供されていることに注意してください rinohtype それがそうです。建築業者の名前は rinoh それがそうです。参考にする rinohtype manual もっと細かいことを知っています。

class sphinx.builders.text.TextBuilder

このビルダはRESTファイルごとに1つのテキストファイルを生成する--これはRESTソースコードとほぼ同じであるが，より良い可読性のためにタグの大部分を除いている.

name = 'text'

format = 'text'

supported_image_types = []

バージョン 0.4 で追加.

class sphinx.builders.manpage.ManualPageBuilder

このビルダはGroff形式のマニュアルページを生成する.属性は，どの文書がどのマニュアルページに含まれるかを指定する. man_pages 値を配置する。

name = 'man'

format = 'man'

supported_image_types = []

バージョン 1.0 で追加.

class sphinx.builders.texinfo.TexinfoBuilder

このビルダによって生成されたTexInfoファイルは makeinfo プログラムです。属性は、どのTexinfoファイルに含まれる文書を指定しますか texinfo_documents 値を配置する。

Infoフォーマットは、GNU Emacsが使用するオンラインヘルプシステムおよび端末ベースのプログラムの基本です。 info それがそうです。見 テクスチャ情報情報 もっと細かいことを知っています。TexinfoフォーマットはGNUプロジェクトが使用する公的文書システムである.Texinfoに関するもっと多くの情報は、アクセスしてください https://www.gnu.org/software/texinfo/ それがそうです。

name = 'texinfo'

format = 'texinfo'

supported_image_types = ['image/png', 'image/jpeg', 'image/gif']

バージョン 1.1 で追加.

class sphinxcontrib.serializinghtml.SerializingHTMLBuilder

This builder uses a module that implements the Python serialization API (pickle, simplejson, phpserialize, and others) to dump the generated HTML documentation. The pickle builder is a subclass of it.

この生成器の具体的なサブクラスは PHP serialization フォーマットは以下のようになる場合があります。

import phpserialize

class PHPSerializedBuilder(SerializingHTMLBuilder):
    name = 'phpserialized'
    implementation = phpserialize
    out_suffix = '.file.phpdump'
    globalcontext_filename = 'globalcontext.phpdump'
    searchindex_filename = 'searchindex.phpdump'

implementation

A module that implements dump(), load(), dumps() and loads() functions that conform to the functions with the same names from the pickle module. Known modules implementing this interface are simplejson, phpserialize, plistlib, and others.

out_suffix

すべての通常文書の接尾辞

globalcontext_filename

“グローバルコンテキスト”を含むファイルのファイル名です。これは、項目名のような通常の構成値を有する辞書である。

searchindex_filename

Sphinxが生成した検索インデックスのファイル名.

見 直列化構築器詳細情報 出力フォーマットの詳細については、参照されたい。

バージョン 0.5 で追加.

class sphinxcontrib.serializinghtml.PickleHTMLBuilder

このビルダは、標準HTMLテンプレートを使用しないWebアプリケーション(またはカスタム後処理ツール)の使用のために、HTMLセグメントおよびTOC情報を主に含むPickleファイルを含むディレクトリを生成する。

見 直列化構築器詳細情報 出力フォーマットの詳細については、参照されたい。

name = 'pickle'

古い名前. web まだ有効です。

format = 'html'

supported_image_types = ['image/svg+xml', 'image/png', 'image/gif', 'image/jpeg']

文書接尾辞は .fpickle それがそうです。大域的文脈と呼ぶ globalcontext.pickle ，索引を検索する searchindex.pickle それがそうです。

class sphinxcontrib.serializinghtml.JSONHTMLBuilder

このビルダは、標準HTMLテンプレートを使用しないWebアプリケーション(またはカスタム後処理ツール)のためのディレクトリを生成し、その中に含まれるJSONファイルは、主にHTMLセグメントおよびTOC情報を含む。

見 直列化構築器詳細情報 出力フォーマットの詳細については、参照されたい。

name = 'json'

format = 'html'

supported_image_types = ['image/svg+xml', 'image/png', 'image/gif', 'image/jpeg']

文書接尾辞は .fjson それがそうです。大域的文脈と呼ぶ globalcontext.json ，索引を検索する searchindex.json それがそうです。

バージョン 0.5 で追加.

class sphinx.builders.gettext.MessageCatalogBuilder

このビルダはgettextスタイルのメッセージディレクトリを生成する.トップレベルのファイルやサブディレクトリは1つずつ増加します .pot 要素ライブラリテンプレート。

上の文書を参照してください 国際化する. さらなる参考に供する。

name = 'gettext'

format = ''

supported_image_types = []

バージョン 1.1 で追加.

class sphinx.builders.changes.ChangesBuilder

This builder produces an HTML overview of all versionadded, versionchanged and deprecated directives for the current version. This is useful to generate a ChangeLog file, for example.

name = 'changes'

format = ''

supported_image_types = []

class sphinx.builders.dummy.DummyBuilder

このビルダは何の出力も発生しない.入力に対してのみ解析と整合性検査を行う.これは革綿の用途に有用です。

name = 'dummy'

supported_image_types = []

バージョン 1.4 で追加.

class sphinx.builders.linkcheck.CheckExternalLinksBuilder

このビルダはすべての文書中の外部リンクをスキャンし，利用を試みている. requests そして、どのファイルが破損し、標準出力にリダイレクトされたかについての概要が書かれている。 output.txt 出力ディレクトリにあります。

name = 'linkcheck'

format = ''

supported_image_types = []

バージョン 1.5 で変更: Sphinx-1.5から，linkcheckビルダは要求モジュールの使用を開始する.

バージョン 3.4 で変更: サーバがレート制限を適用した場合，リンクチェック構築者はリンクを再試行する.

class sphinx.builders.xml.XMLBuilder

このビルダはDocutilsネイティブXML文書を生成する.出力は標準的なXMLツール(たとえばXSLTプロセッサ)を用いて任意の最終形式に変換することができる.

name = 'xml'

format = 'xml'

supported_image_types = []

バージョン 1.2 で追加.

class sphinx.builders.xml.PseudoXMLBuilder

このビルダは、Sphinx/Docutils“Reader to Transform to Writer”パイプをデバッグするために使用されます。これは、入れ子がインデントによって表される精巧で美しい“擬似XML”ファイルを生成する(終了タグなし)。すべての要素の外部属性を出力し、任意の残りの“保留”要素の内部属性を与える。

name = 'pseudoxml'

format = 'pseudoxml'

supported_image_types = []

バージョン 1.2 で追加.

より多くの構築器を提供する内蔵Sphinx拡張は、：

• doctest

• coverage

直列化構築器詳細情報

すべての直列化ビルダは、ソースファイル毎に1つのファイルといくつかの特殊ファイルとを出力する。ディレクトリのRESTソースファイルもコピーします _sources 出力ディレクトリの下にあります。

♪the PickleHTMLBuilder Pickle直列化インタフェースを実現する内蔵サブクラスである.

各ソースファイルのファイル拡張子は out_suffix ソースファイルと同様にディレクトリに配列する.これらは、以下のキーを使用して辞書(または類似辞書の構造)に逆直列化される。

body

HTML“本文”(すなわちソースファイルのHTMLプレゼンテーション)は，HTMLトランスレータによって提示される.

title

HTML(タグを含むことができる)のような文書のタイトル.

toc

文書のディレクトリは，HTMLとして提示される. <ul> それがそうです。

display_toc

1つのブール値は True もし toc 複数の項目が含まれている。

current_page_name

現在のファイルの文書名。

parents, prev and next

ディレクトリ木における関連章に関する情報.どの関係もキー付きの辞書です link (関係のHREF)と title (HTMLのような関連文書のタイトル)。 parents 関係のリストです prev そして next 単一の関係です

sourcename

下のソースファイルの名前 _sources それがそうです。

特殊ファイルはルート出力ディレクトリに位置する.これらは

SerializingHTMLBuilder.globalcontext_filename

以下のキーワードの漬け辞書を使用する：

project, copyright, release, version

プロファイルで与えられた値と同じである.

style

html_style それがそうです。

last_updated

前回生成された日付。

builder

使用されている構造器の名前は、キムチについては、常に 'pickle' それがそうです。

titles

HTML文字列のようなすべての文書タイトルの辞書。

SerializingHTMLBuilder.searchindex_filename

文書のインデックスを検索するために利用可能である.これは以下の項目を含む塩漬けリストです。

• インデックス文書名リスト.

• 文書タイトルリストは，形式はHTML文字列であり，順序は1番目のリストと同じである.

• 語根(英語語幹解析器で処理される)を整数リストの辞書にマッピングし，整数リストは最初のリストのインデックスである.

environment.pickle

環境を構築する。これは，ビルダおよびビルダを起動する際に使用される環境のコピーとは独立したPICLEファイルである.

課題

公共のメンバーを記録する。

他のPickleファイルとは異なり、このPickleファイル要求 sphinx 包装は非酸洗時に使えます。