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

Force typing_extensions==4.6.1 in doc build #564

Merged
merged 3 commits into from
May 10, 2024

Conversation

ashao
Copy link
Member

@ashao ashao commented Apr 22, 2024

Tensorflow requires that typing_extensions<=4.6.0, however this cuases the sphinx build process to fail due to an error importing sphinx_tabs. This is potentially a misleading error because sphinx_tabs itself does not use typing extensions, but the problem nevertheless exists even when testing other versions of Sphinx. To allow the deploy_dev_docs action to complete, this modifies the Dockerfile used to build the docs to ensure that
typing_extensions==4.6.1 (which is the lowest version that does not throw pip resolution errors) is present in the python environment prior to the build.

Tensorflow requires that typing_extensions<=4.6.0, however this
cuases the sphinx build process to fail due to an error importing
sphinx_tabs. This is potentially a misleading error because
sphinx_tabs itself does not use typing extensions, but the problem
nevertheless exists even when testing other versions of Sphinx. To
allow the deploy_dev_docs action to complete, this modifies the
Dockerfile used to build the docs to ensure that
typing_extensions==4.6.1 (which is the lowest version that does
not throw pip resolution errors) is present in the python
environment prior to the build.
@@ -116,6 +119,7 @@ Detailed Notes
handler. SmartSim will now attempt to kill any launched jobs before calling
the previously registered signal handler. (SmartSim-PR535_)

.. _SmartSim-PR561: https://github.com/CrayLabs/SmartSim/pull/561
Copy link
Contributor

Choose a reason for hiding this comment

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

I believe this might be PR 564 instead of 561!

Copy link
Contributor

@amandarichardsonn amandarichardsonn left a comment

Choose a reason for hiding this comment

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

LGTM! Just one small fix

Copy link

codecov bot commented May 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.54%. Comparing base (7db8490) to head (3f9ed1b).
Report is 2 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##           develop     #564      +/-   ##
===========================================
+ Coverage    77.77%   78.54%   +0.76%     
===========================================
  Files           66       67       +1     
  Lines         4571     4637      +66     
===========================================
+ Hits          3555     3642      +87     
+ Misses        1016      995      -21     

see 31 files with indirect coverage changes

@ashao ashao merged commit 0f4c765 into CrayLabs:develop May 10, 2024
36 checks passed
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.

2 participants