RDT build suddenly starts failing without any changes in conf.py

[RobiFag]

Details

• Read the Docs project URL: https://readthedocs.org/projects/manuale-catasto-strade/
• Build URL (if applicable): https://readthedocs.org/projects/manuale-catasto-strade/builds/16458010/
• Read the Docs username (if applicable): https://readthedocs.org/profiles/RobiFag/

Actual Result

Everything worked fine till few hours ago then the build started failing. We don't have modified any configuration in the conf.py file and just added text and images to a page of the manual.

The errors are:
ImportError: cannot import name 'contextfunction' from 'jinja2' (/home/docs/checkouts/readthedocs.org/user_builds/manuale-catasto-strade/envs/novara/lib/python3.7/site-packages/jinja2/__init__.py)

Could not import extension sphinx.builders.latex (exception: cannot import name 'contextfunction' from 'jinja2' (/home/docs/checkouts/readthedocs.org/user_builds/manuale-catasto-strade/envs/novara/lib/python3.7/site-packages/jinja2/__init__.py))

We get the same errors in another manual:

• Read the Docs project URL: https://readthedocs.org/projects/template-rtd/
• Build URL (if applicable): https://readthedocs.org/projects/template-rtd/builds/16458056/
• Read the Docs username (if applicable): https://readthedocs.org/profiles/RobiFag/

[ericholscher]

I'm guessing this is because of a new release of jinja2 (https://github.com/pallets/jinja/releases). You'll need to pin your jinja2 requirement in your build to ensure it continues to work to jinja2<3.1.0. We recommend upgrading from Sphinx 1.8 though, because these kind of issues will continue to happen on older dependencies.

We are also deploying a fix to Sphinx 1.8 to work around this, but we generally do recommend upgrading: https://docs.readthedocs.io/en/latest/guides/reproducible-builds.html#using-a-configuration-file

[RobiFag]

Hi @ericholscher now the build starts working correctly without any changes!

Anyway thanks for the suggestions, I will try to update Sphinx!

[lizadams]

Also having this issue https://readthedocs.org/projects/cyclecloud-cmaq/

[lizadams]

The error is also described here: pallets/jinja#1631
It hasn't been resolved for two of my projects.
ericholscher
I've set

# File: docs/requirements.txt
#
# sphinx==4.2.0
# sphinx_rtd_theme==1.0.0
# readthedocs-sphinx-search==0.1.1
# jinja2==3.0.0

and

# File: docs/environment.yaml

name: docs
channels:
  - conda-forge
  - defaults
dependencies:
  - sphinx==4.2.0
  - nbsphinx==0.8.1
  - pip:
    - sphinx_rtd_theme==1.0.0
    - jinja2==3.0.0

It doesn't resolve the error.

[ericholscher]

@lizadams it looks like your requirements file is commented out. You need to remove the # before the dependencies, and likely pin your mkdocs version, not sphinx.

[lizadams]

@ericholscher - Thanks!
This seems to have worked:

# File: docs/requirements.txt
mkdocs==1.2.3
jinja2==3.0.0

# File: docs/environment.yaml

name: docs
channels:
  - conda-forge
  - defaults
dependencies:
  - mkdocs==1.2.3
  - pip:
    - jinja2==3.0.0