Skip to content

Document external Jinja template rebuild workflow #214

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
sapunyangkut wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Document external Jinja template rebuild workflow #214

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <relevant sphinx bugs_>`__
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
----------------------------

Expand Down