Skip to content

python: fix tox -e docs by pinning Jinja2#10492

Merged
diemol merged 2 commits intoSeleniumHQ:trunkfrom
symonk:fix-tox-docs
Mar 30, 2022
Merged

python: fix tox -e docs by pinning Jinja2#10492
diemol merged 2 commits intoSeleniumHQ:trunkfrom
symonk:fix-tox-docs

Conversation

@symonk
Copy link
Copy Markdown
Member

@symonk symonk commented Mar 29, 2022 •
edited
Loading

Looks like Jinja2 released a few updates on 24th & 25th of March that our tox -e docs is auto aquiring due to lack of pinning in there? I've pinned Jinja2 on an older working version and my local tox -e docs now exits 0.

before:

Running Sphinx v1.8.2

Extension error:
Could not import extension sphinx.builders.latex (exception: cannot import name 'contextfunction' from 'jinja2' (/home/{user}/workspaces/selenium/py/.tox/docs/lib/python3.7/site-packages/jinja2/__init__.py))

after:

dumping object inventory... done
build succeeded, 26 warnings.

The HTML pages are in ../build/docs/api/py.
_________________________________________________________________________________________________________________ summary _________________________________________________________________________________________________________________
  docs: commands succeeded
  congratulations :)

Sphinx 1.8.2 is extremely old; we should maybe consider updating that in the very near future.

Example of an impacted PR: #10490

symonk
symonk commented Mar 29, 2022
View reviewed changes
Comment thread py/tox.ini
[testenv:docs]
skip_install = true
deps =
Jinja2==3.0.3
Copy link
Copy Markdown
Member Author

@symonk symonk Mar 29, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

initially broken here by Jinja2==3.1.0 released on march 24th.

@symonk symonk changed the title fix tox -e docs by pinning Jinja2 python: fix tox -e docs by pinning Jinja2 Mar 29, 2022
diemol
diemol approved these changes Mar 30, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@diemol diemol left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @symonk!

@diemol diemol merged commit 6ec4b33 into SeleniumHQ:trunk Mar 30, 2022
@symonk symonk deleted the fix-tox-docs branch March 30, 2022 20:33
elgatov pushed a commit to elgatov/selenium that referenced this pull request Jun 27, 2022
@symonk @elgatov
fix tox -e docs by pinning Jinja2 (SeleniumHQ#10492)
d5a31be 
[run python]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@diemol diemol diemol approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@symonk @diemol