summaryrefslogtreecommitdiff
path: root/doc/templating.rst
diff options
context:
space:
mode:
authorgeorg.brandl <devnull@localhost>2008-03-25 19:20:26 +0000
committergeorg.brandl <devnull@localhost>2008-03-25 19:20:26 +0000
commitc30cefc6ef1cd706702ea5b710785447341087f3 (patch)
tree431f39a8dd4a2dce6463ef523ab39f9007aa5aeb /doc/templating.rst
parenta496f16b1464d51c3234349b1b9ff3431123672a (diff)
downloadsphinx-c30cefc6ef1cd706702ea5b710785447341087f3.tar.gz
Expand on the pickle builder.
Diffstat (limited to 'doc/templating.rst')
-rw-r--r--doc/templating.rst18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/templating.rst b/doc/templating.rst
index ed289102..0befdbe3 100644
--- a/doc/templating.rst
+++ b/doc/templating.rst
@@ -8,6 +8,24 @@ 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.
+
+Do I need to use Sphinx' templates to produce HTML?
+---------------------------------------------------
+
+No. You have several other options:
+
+* You can :ref:`write a custom builder <writing-builders>` that derives from
+ :class:`~sphinx.builder.StandaloneHTMLBuilder` and calls your template engine
+ of choice.
+
+* You can use the :class:`~sphinx.builder.PickleHTMLBuilder` that produces
+ pickle files with the page contents, and postprocess them using a custom tool,
+ or use them in your Web application.
+
+
+Jinja/Sphinx Templating Primer
+------------------------------
+
The most important concept in Jinja is :dfn:`template inheritance`, which means
that you can overwrite only specific blocks within a template, customizing it
while also keeping the changes at a minimum.