Skip to content
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.

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

Issue with Jinja2 v3.1.1 #10306

Closed
mvadari opened this issue Mar 29, 2022 · 3 comments
Closed

Issue with Jinja2 v3.1.1 #10306

mvadari opened this issue Mar 29, 2022 · 3 comments

Comments

@mvadari
Copy link

mvadari commented Mar 29, 2022

Describe the bug

I'm trying to set up Sphinx in a new repo and I'm running into an error with Jinja2. It errors when I use Jinja2 v3.1.1, but is fine with v3.0.3.

$ poetry run sphinx-apidoc -o source/ ../folder
Traceback (most recent call last):
  File "/Users/mvadari/Documents/folder/.venv/bin/sphinx-apidoc", line 5, in <module>
    from sphinx.ext.apidoc import main
  File "/Users/mvadari/Documents/folder/.venv/lib/python3.8/site-packages/sphinx/ext/apidoc.py", line 31, in <module>
    from sphinx.cmd.quickstart import EXTENSIONS
  File "/Users/mvadari/Documents/folder/.venv/lib/python3.8/site-packages/sphinx/cmd/quickstart.py", line 44, in <module>
    from sphinx.util.template import SphinxRenderer
  File "/Users/mvadari/Documents/folder/.venv/lib/python3.8/site-packages/sphinx/util/template.py", line 22, in <module>
    from sphinx.jinja2glue import SphinxFileSystemLoader
  File "/Users/mvadari/Documents/folder/.venv/lib/python3.8/site-packages/sphinx/jinja2glue.py", line 15, in <module>
    from jinja2 import BaseLoader, FileSystemLoader, TemplateNotFound, contextfunction
ImportError: cannot import name 'contextfunction' from 'jinja2' (/Users/mvadari/Documents/sidechain-launch-kit/.venv/lib/python3.8/site-packages/jinja2/__init__.py)

How to Reproduce

Upgrade Jinja2 to 3.1.1, and attempt to run sphinx-apidoc.

Expected behavior

I expected the Sphinx .rst docs to generate properly, but instead there was an error.

Your project

I'm still setting up Sphinx

Screenshots

No response

OS

Mac

Python version

3.8.0

Sphinx version

3.1.1

Sphinx extensions

No response

Extra tools

Poetry v1.1.11

Additional context

No response

@rossbar
Copy link

rossbar commented Mar 29, 2022

This is also affecting numpydoc and scipy (scipy/scipy#15895), albeit with older sphinx versions (2.1)

@mvadari
Copy link
Author

mvadari commented Mar 29, 2022

My solution was to upgrade Sphinx to 4.5.0.

@stsewd
Copy link
Contributor

stsewd commented Mar 29, 2022

This is a duplicate of #10291, you can update sphinx to the latest version or pin Jinja2 Jinja2<3.1 in your dependencies.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

4 participants