查找从 sphinx 传递给 jinja2 的变量
Finding variables passed to jinja2 from sphinx
我正在尝试在 sphinx 中创建模板。我的意图不是使用基本模板，而是从头开始构建一个新模板。然而，关于哪些变量从 sphinx 传递到模板的文档很少（/没有）。
我想转储从 sphinx 传递到模板的所有变量。 （最好在模板中，因为我的 python 知识不多！）
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'
}
，您可以访问 pdf_path 变量作为 {{theme_pdf_path}}。
或者，可以在主题的 theme.conf 文件中定义自定义主题变量。在我们的示例中，您将添加行 pdf_path = /docs/MyDocs.pdf.
我正在尝试在 sphinx 中创建模板。我的意图不是使用基本模板，而是从头开始构建一个新模板。然而，关于哪些变量从 sphinx 传递到模板的文档很少（/没有）。
我想转储从 sphinx 传递到模板的所有变量。 （最好在模板中，因为我的 python 知识不多！）
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'
}
，您可以访问 pdf_path 变量作为 {{theme_pdf_path}}。
或者，可以在主题的 theme.conf 文件中定义自定义主题变量。在我们的示例中，您将添加行 pdf_path = /docs/MyDocs.pdf.