From 2c276f2c8172c932dff7c897d846985a67f80ca9 Mon Sep 17 00:00:00 2001 From: sapunyangkut <302607731+sapunyangkut@users.noreply.github.com> Date: Tue, 14 Jul 2026 20:45:27 +0800 Subject: [PATCH] Document external Jinja template workflow --- README.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.rst b/README.rst index 190b9a1..6c93a5e 100644 --- a/README.rst +++ b/README.rst @@ -127,6 +127,20 @@ all pages are built from the same state of the HTML theme. It also works around a `known issue in Sphinx `__ which causes significant problems during theme development. +Working with external Jinja templates +------------------------------------- + +If an extension generates reStructuredText from Jinja templates outside the +Sphinx source directory, watch the template directory and disable incremental +builds and the cached Sphinx environment: + +.. code-block:: bash + + sphinx-autobuild -aE docs docs/_build/html --watch path/to/templates + +This is slower, but ensures every page uses the current templates and +configuration. + Working on multiple projects ----------------------------