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

update sphinx dependencies to fix jinja2 doc build error #1551

Merged
merged 1 commit into from
Jul 12, 2022

Conversation

imatiach-msft
Copy link
Contributor

@imatiach-msft imatiach-msft commented Jul 12, 2022

Description

The website build (GitHub Pages / website-build-and-deploy) seems to be failing with jinja2 error. This PR updates sphinx package, which should work with the newer version of jinja2, in order to fix the workflow error.

Traceback (most recent call last):
  File "/opt/hostedtoolcache/Python/3.7.[13](https://github.com/microsoft/responsible-ai-toolbox/runs/7304145628?check_suite_focus=true#step:5:14)/x64/bin/sphinx-build", line 5, in <module>
    from sphinx.cmd.build import main
  File "/opt/hostedtoolcache/Python/3.7.13/x64/lib/python3.7/site-packages/sphinx/cmd/build.py", line 25, in <module>
    from sphinx.application import Sphinx
  File "/opt/hostedtoolcache/Python/3.7.13/x64/lib/python3.7/site-packages/sphinx/application.py", line 42, in <module>
    from sphinx.registry import SphinxComponentRegistry
  File "/opt/hostedtoolcache/Python/3.7.13/x64/lib/python3.7/site-packages/sphinx/registry.py", line 24, in <module>
    from sphinx.builders import Builder
  File "/opt/hostedtoolcache/Python/3.7.13/x64/lib/python3.7/site-packages/sphinx/builders/__init__.py", line 26, in <module>
    from sphinx.util import import_object, logging, rst, progress_message, status_iterator
  File "/opt/hostedtoolcache/Python/3.7.13/x64/lib/python3.7/site-packages/sphinx/util/rst.py", line 22, in <module>
    from jinja2 import environmentfilter
ImportError: cannot import name 'environmentfilter' from 'jinja2' (/opt/hostedtoolcache/Python/3.7.13/x64/lib/python3.7/site-packages/jinja2/__init__.py)

Checklist

  • I have added screenshots above for all UI changes.
  • I have added e2e tests for all UI changes.
  • Documentation was updated if it was needed.

@codecov-commenter
Copy link

codecov-commenter commented Jul 12, 2022

Codecov Report

Merging #1551 (62a7639) into main (98cd722) will decrease coverage by 2.27%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #1551      +/-   ##
==========================================
- Coverage   87.39%   85.12%   -2.28%     
==========================================
  Files         107       57      -50     
  Lines        5069     2877    -2192     
==========================================
- Hits         4430     2449    -1981     
+ Misses        639      428     -211     
Flag Coverage Δ
unittests 85.12% <ø> (-2.28%) ⬇️

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

Impacted Files Coverage Δ
...ponsibleai/responsibleai/_tools/shared/versions.py
...ponsibleai/responsibleai/modelanalysis/__init__.py
responsibleai/responsibleai/_managers/__init__.py
responsibleai/responsibleai/_interfaces.py
...ai/databalanceanalysis/feature_balance_measures.py
responsibleai/responsibleai/_data_validations.py
...ai/responsibleai/rai_insights/rai_base_insights.py
responsibleai/responsibleai/__init__.py
...sibleai/responsibleai/_tools/shared/base_result.py
responsibleai/responsibleai/_tools/__init__.py
... and 40 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 98cd722...62a7639. Read the comment docs.

@imatiach-msft imatiach-msft force-pushed the ilmat/fix-sphinx-build branch from 4af1b3e to 62a7639 Compare July 12, 2022 16:00
1 similar comment
@imatiach-msft imatiach-msft merged commit 5f90591 into main Jul 12, 2022
@imatiach-msft imatiach-msft deleted the ilmat/fix-sphinx-build branch July 12, 2022 17:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants