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

Docs build: refactor markupsafe dependency pin to be outside of requirements.txt #2261

Merged
merged 5 commits into from May 19, 2021

Conversation

dsherry
Copy link
Contributor

@dsherry dsherry commented May 12, 2021

Follow-up from #2244 .

Since MarkupSafe is only needed for the docs, and is not needed to run evalml, it shouldn't be listed in our requirements.txt. So this PR moves it out of there.

Thanks to @rwedge for the ultimate solution!

@dsherry dsherry added documentation Improvements or additions to documentation testing Issues related to testing. task Scripting, configuration, or other work which doesn't categorize well as a feature/enhancement/bug. labels May 12, 2021
@dsherry dsherry changed the title Docs build: move a dependency pin to be outside of requirements.txt Docs build: refactor markupsafe dependency pin to be outside of requirements.txt May 18, 2021
@codecov
Copy link

codecov bot commented May 18, 2021

Codecov Report

Merging #2261 (fb336e5) into main (0c10cd5) will increase coverage by 10.5%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##            main    #2261      +/-   ##
=========================================
+ Coverage   89.5%   100.0%   +10.5%     
=========================================
  Files        280      280              
  Lines      24392    24392              
=========================================
+ Hits       21827    24369    +2542     
+ Misses      2565       23    -2542     
Impacted Files Coverage Δ
evalml/tests/utils_tests/test_dependencies.py 85.2% <0.0%> (ø)
evalml/automl/automl_search.py 100.0% <0.0%> (+0.4%) ⬆️
evalml/tests/utils_tests/test_logger.py 100.0% <0.0%> (+0.6%) ⬆️
evalml/pipelines/utils.py 100.0% <0.0%> (+1.0%) ⬆️
evalml/tests/conftest.py 100.0% <0.0%> (+1.1%) ⬆️
...derstanding/prediction_explanations/_algorithms.py 98.9% <0.0%> (+1.2%) ⬆️
evalml/tests/component_tests/test_estimators.py 100.0% <0.0%> (+1.9%) ⬆️
evalml/tests/component_tests/test_components.py 100.0% <0.0%> (+2.8%) ⬆️
evalml/tests/component_tests/test_utils.py 97.5% <0.0%> (+3.8%) ⬆️
...valml/tests/pipeline_tests/test_component_graph.py 100.0% <0.0%> (+3.9%) ⬆️
... and 37 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 0c10cd5...fb336e5. Read the comment docs.

- method: pip
path: .
- requirements: docs-requirements.txt
Copy link
Contributor Author

@dsherry dsherry May 18, 2021

Choose a reason for hiding this comment

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

This is what did it. First install evalml dependencies, then install the pinned MarkupSafe 1.1.1 (which was already done in docs/docs-requirements.txt before this PR)

Copy link
Contributor

Choose a reason for hiding this comment

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

It should be ok to remove the MarkupSafe requirement from docs-requirements as well, since nbsphinx>=0.8.5, which is present in the docs requirements, also addresses the Markupsafe issue in its own requirements

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah thanks, will do

@@ -5,7 +5,6 @@ ipywidgets>=7.5
xgboost>=0.82,<1.3.0
catboost>=0.20
lightgbm>=2.3.1,<3.1.0
MarkupSafe==1.1.1
Copy link
Contributor Author

Choose a reason for hiding this comment

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

🥂

@dsherry dsherry marked this pull request as ready for review May 18, 2021 21:25
@dsherry dsherry requested review from rwedge and bchen1116 May 18, 2021 21:25
Copy link
Contributor

@rwedge rwedge left a comment

Choose a reason for hiding this comment

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

looks good, assuming things pass

@dsherry dsherry merged commit 72b7fd1 into main May 19, 2021
@chukarsten chukarsten mentioned this pull request May 24, 2021
@chukarsten chukarsten mentioned this pull request Jun 2, 2021
@freddyaboulton freddyaboulton deleted the ds_rtd_markupsafe_pin branch May 13, 2022 15:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation task Scripting, configuration, or other work which doesn't categorize well as a feature/enhancement/bug. testing Issues related to testing.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants