You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The messaging of copying static files can be inaccurate in cases where Sphinx copies content that includes templated files (because those are evaluated by jinja and the results are written instead of the original template's contents).
copying static files... failed
...
Failed to copy a file in html_static_file: /home/runner/work/sphinx-automodapi/sphinx-automodapi/.tox/py310-test-sphinxdev/lib/python3.10/site-packages/alabaster/static/alabaster.css_t: OldJinjaSuffixWarning("'/home/runner/work/sphinx-automodapi/sphinx-automodapi/.tox/py310-test-sphinxdev/lib/python3.10/site-packages/alabaster/static/alabaster.css_t': the '_t' suffix for Jinja templates is deprecated. If the file is a template, use the suffix '.jinja' instead. For more information, see https://www.sphinx-doc.org/en/master/development/theming.html#static-templates")
As a possible improvement I'd suggest copying static files and evaluating Jinja templates.
How to Reproduce
Invoking the sphinx-build -b html . _build command to build a Sphinx project as HTML emits this message as part of the output.
jayaddison
changed the title
html builder: messaging improvement: mention template evaluation during file copying
Messaging improvement: mention template evaluation during file copying
Aug 1, 2024
Describe the bug
The messaging of
copying static files
can be inaccurate in cases where Sphinx copies content that includes templated files (because those are evaluated byjinja
and the results are written instead of the original template's contents).This may be rare, but it's particularly incongruous messaging when builds treat warnings as failures, as seen here: https://github.com/astropy/sphinx-automodapi/actions/runs/4694556705/jobs/8322825594#step:8:170
As a possible improvement I'd suggest
copying static files and evaluating Jinja templates
.How to Reproduce
Invoking the
sphinx-build -b html . _build
command to build a Sphinx project as HTML emits this message as part of the output.Environment Information
Sphinx extensions
Additional context
Localisation of the updated message will be required.
The text was updated successfully, but these errors were encountered: