sphinxからjinja2に渡される変数を見つける

Question

私はsphinxでテンプレートを作成しようとしています。私の意図は、基本テンプレートを使用するのではなく、最初から新しいテンプレートを作成することです。しかし、どの変数がsphinxからテンプレートに渡されるかについては、ほとんど（/ no）ドキュメントがありません。

テンプレートに渡されるすべての変数をsphinxからダンプしたいと思います。 （理想的には、私のPythonの知識が良くないのでテンプレート内で！）

Answer 1

Sphinxのドキュメントにはテンプレートで利用可能なlist of most variablesがあります。 this dictionary (Sphinx source code)には、docutilsによってほとんどが渡された追加の変数があります。

さらに、conf.pyファイルのhtml_theme_options辞書を使用して、独自のテンプレートにカスタム構成変数を追加することができます。

カスタム構成変数は、接頭辞theme_でアクセスする必要があります。カスタム変数を定義する場合

は例えば、次のように：

html_theme_options = { 
    'pdf_path': '/docs/MyDocs.pdf' 
} 

、あなたが{{theme_pdf_path}}としてpdf_path変数にアクセスすることができます。

また、テーマのtheme.confファイルでカスタムテーマ変数を定義することもできます。この例では、pdf_path = /docs/MyDocs.pdfという行を追加します。