发布于 2015-09-16 15:41:18 | 258 次阅读 | 评论: 0 | 来源: 网络整理
Sphinx uses the Jinja templating engine for its HTML templates. Jinja is a text-based engine, and inspired by Django templates, so anyone having used Django will already be familiar with it. It also has excellent documentation for those who need to make themselves familiar with it.
No. You have several other options:
TemplateBridge subclass that calls your template engine of choice, and set the :confval:`template_bridge` configuration value accordingly.StandaloneHTMLBuilder and calls your template engine of choice.PickleHTMLBuilder that produces pickle files with the page contents, and postprocess them using a custom tool, or use them in your Web application.The default templating language in Sphinx is Jinja. It’s Django/Smarty inspired and easy to understand. The most important concept in Jinja is template inheritance, which means that you can overwrite only specific blocks within a template, customizing it while also keeping the changes at a minimum.
To customize the output of your documentation you can override all the templates (both the layout templates and the child templates) by adding files with the same name as the original filename into the template directory of the structure the Sphinx quickstart generated for you.
Sphinx will look for templates in the folders of :confval:`templates_path` first, and if it can’t find the template it’s looking for there, it falls back to the selected theme’s templates.
A template contains variables, which are replaced with values when the template is evaluated, tags, which control the logic of the template and blocks which are used for template inheritance.
Sphinx’ basic theme provides base templates with a couple of blocks it will fill with data. These are located in the themes/basic subdirectory of the Sphinx installation directory, and used by all builtin Sphinx themes. Templates with the same name in the :confval:`templates_path` override templates supplied by the selected theme.
For example, to add a new link to the template area containing related links all you have to do is to add a new template called layout.html with the following contents:
{% extends "!layout.html" %}
{% block rootrellink %}
<li><a href="http://project.invalid/">Project Homepage</a> »</li>
{{ super() }}
{% endblock %}
By prefixing the name of the overridden template with an exclamation mark, Sphinx will load the layout template from the underlying HTML theme.
Important: If you override a block, call {{ super() }} somewhere to render the block’s content in the extended template – unless you don’t want that content to show up.
The builtin basic theme supplies the templates that all builtin Sphinx themes are based on. It has the following elements you can override or use:
The following blocks exist in the layout.html template:
<link> tags to the head section of the template.<head> tag of the generated HTML file. This is the right place to add references to JavaScript or extra CSS files.This block contains the relation bar, the list of related links (the parent documents on the left, and the links to index, modules etc. on the right). relbar1 appears before the document, relbar2 after the document. By default, both blocks are filled; to show the relbar only before the document, you would override relbar2 like this:
{% block relbar2 %}{% endblock %}
reldelim1.page.html.A possible location for a sidebar. sidebar1 appears before the document and is empty by default, sidebar2 after the document and contains the default sidebar. If you want to swap the sidebar location override this and call the sidebar helper:
{% block sidebar1 %}{{ sidebar() }}{% endblock %}
{% block sidebar2 %}{% endblock %}
(The sidebar2 location for the sidebar is needed by the sphinxdoc.css stylesheet, for example.)
The following four blocks are only used for pages that do not have assigned a list of custom sidebars in the :confval:`html_sidebars` config value. Their use is deprecated in favor of separate sidebar templates, which can be included via :confval:`html_sidebars`.
The table of contents within the sidebar.
Deprecated since version 1.0.
The relation links (previous, next document) within the sidebar.
Deprecated since version 1.0.
The “Show source” link within the sidebar (normally only shown if this is enabled by :confval:`html_show_sourcelink`).
Deprecated since version 1.0.
The search box within the sidebar. Override this if you want to place some content at the bottom of the sidebar.
Deprecated since version 1.0.
Inside templates you can set a couple of variables used by the layout template using the {% set %} tag:
reldelim1The delimiter for the items on the left side of the related bar. This defaults to ' »' Each item in the related bar ends with the value of this variable.
reldelim2The delimiter for the items on the right side of the related bar. This defaults to ' |'. Each item except of the last one in the related bar ends with the value of this variable.
Overriding works like this:
{% extends "!layout.html" %}
{% set reldelim1 = ' >' %}
script_filesAdd additional script files here, like this:
{% set script_files = script_files + ["_static/myscript.js"] %}
css_filesSimilar to script_files, for CSS files.
Sphinx provides various Jinja functions as helpers in the template. You can use them to generate links or output multiply used elements.
pathto(document)Return the path to a Sphinx document as a URL. Use this to refer to built documents.
pathto(file, 1)Return the path to a file which is a filename relative to the root of the generated output. Use this to refer to static files.
hasdoc(document)Check if a document with the name document exists.
Return the rendered sidebar.
relbar()Return the rendered relation bar.
These global variables are available in every template and are safe to use. There are more, but most of them are an implementation detail and might change in the future.
builderThe name of the builder (e.g. html or htmlhelp).
copyrightThe value of :confval:`copyright`.
docstitleThe title of the documentation (the value of :confval:`html_title`).
embeddedTrue if the built HTML is meant to be embedded in some viewing application that handles navigation, not the web browser, such as for HTML help or Qt help formats. In this case, the sidebar is not included.
faviconThe path to the HTML favicon in the static path, or ''.
file_suffixThe value of the builder’s out_suffix attribute, i.e. the file name extension that the output files will get. For a standard HTML builder, this is usually .html.
has_sourceTrue if the reST document sources are copied (if :confval:`html_copy_source` is true).
last_updatedThe build date.
logoThe path to the HTML logo image in the static path, or ''.
master_docThe value of :confval:`master_doc`, for usage with pathto().
nextThe next document for the navigation. This variable is either false or has two attributes link and title. The title contains HTML markup. For example, to generate a link to the next page, you can use this snippet:
{% if next %}
<a href="{{ next.link|e }}">{{ next.title }}</a>
{% endif %}
pagenameThe “page name” of the current file, i.e. either the document name if the file is generated from a reST source, or the equivalent hierarchical name relative to the output directory ([directory/]filename_without_extension).
parentsA list of parent documents for navigation, structured like the next item.
prevLike next, but for the previous page.
projectThe value of :confval:`project`.
releaseThe value of :confval:`release`.
rellinksA list of links to put at the left side of the relbar, next to “next” and “prev”. This usually contains links to the general index and other indices, such as the Python module index. If you add something yourself, it must be a tuple (pagename, link title, accesskey, link text).
shorttitleThe value of :confval:`html_short_title`.
show_sourceTrue if :confval:`html_show_sourcelink` is true.
sphinx_versionThe version of Sphinx used to build.
styleThe name of the main stylesheet, as given by the theme or :confval:`html_style`.
titleThe title of the current document, as used in the <title> tag.
use_opensearchThe value of :confval:`html_use_opensearch`.
versionThe value of :confval:`version`.
In addition to these values, there are also all theme options available (prefixed by theme_), as well as the values given by the user in :confval:`html_context`.
In documents that are created from source files (as opposed to automatically-generated files like the module index, or documents that already are in HTML form), these variables are also available:
metaDocument metadata (a dictionary), see 文件范围的元数据.
sourcenameThe name of the copied source file for the current document. This is only nonempty if the :confval:`html_copy_source` value is true.
tocThe local table of contents for the current page, rendered as HTML bullet lists.
toctreeA callable yielding the global TOC tree containing the current page, rendered as HTML bullet lists. Optional keyword arguments:
collapse (true by default): if true, all TOC entries that are not ancestors of the current page are collapsedmaxdepth (defaults to the max depth selected in the toctree directive): the maximum depth of the tree; set it to -1 to allow unlimited depthtitles_only (false by default): if true, put only toplevel document titles in the tree