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

fix doc ci by pinning jinja version #4239

Merged
merged 1 commit into from
Apr 6, 2022

Conversation

xinjli
Copy link
Contributor

@xinjli xinjli commented Apr 5, 2022

Doc CI is failing now because of a Jinja2 version issue.

Explanation

  • Our current sphinx version explicitly depends on environmentfilter from jinja2, which was depreciated recently.
  • Trying to import this module without pinning to an old jinja2 would cause the ImportError and fail the doc CI process.
  • More details can be seen in this issue: Jinja 2 imports have been deprecated sphinx-doc/sphinx#10291

Fix

The latest sphinx (>4.0.5) seems to already handle this issue, but because we are depending on an old version (2.1.2), we still have this issue. Maybe we should consider upgrading sphinx version in the future.

  • As suggested in the previous issue, pinning jinja to an old version should solve this issue.
  • I have verified that this import error did not happen after pinning in my local environment.

@sw005320 sw005320 added Bugfix CI Travis, Circle CI, etc labels Apr 5, 2022
@sw005320 sw005320 added this to the v.0.10.7 milestone Apr 5, 2022
@mergify mergify bot added the Installation label Apr 5, 2022
@codecov
Copy link

codecov bot commented Apr 5, 2022

Codecov Report

Merging #4239 (e5bfb06) into master (c4aba12) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #4239   +/-   ##
=======================================
  Coverage   80.71%   80.71%           
=======================================
  Files         453      453           
  Lines       39574    39574           
=======================================
  Hits        31943    31943           
  Misses       7631     7631           
Flag Coverage Δ
test_integration_espnet1 67.13% <ø> (ø)
test_integration_espnet2 50.05% <ø> (ø)
test_python 67.16% <ø> (ø)
test_utils 24.45% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

@sw005320 sw005320 merged commit 189e159 into espnet:master Apr 6, 2022
@sw005320
Copy link
Contributor

sw005320 commented Apr 6, 2022

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bugfix CI Travis, Circle CI, etc Installation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants