Skip to content

Commit

Permalink
Readthedocs import extension error (#537)
Browse files Browse the repository at this point in the history
Readthedocs fails and is blocking existing PRs. Failure is: `Extension
error: Could not import extension sphinx_tabs.tabs (exception: cannot
import name 'TypeAliasType' from 'typing_extensions')`. The issue came
from pydantic==2.6.4 and typing_extensions==4.5.0. Sphinx uses Open AI
which requires "pydantic>=1.9.0, <3", "typing-extensions>=4.7, <5". The
versions have been changed in the readthedocs `yaml` file.

[ reviewed by @al-rigazzi ]
[ committed by @amandarichardsonn ]
  • Loading branch information
amandarichardsonn authored Apr 4, 2024
1 parent 6f800b1 commit d462fd2
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
4 changes: 3 additions & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,14 @@ build:
- git clone --depth 1 https://github.com/CrayLabs/SmartRedis.git smartredis
- git clone --depth 1 https://github.com/CrayLabs/SmartDashboard.git smartdashboard
post_create_environment:
- python -m pip install .
- python -m pip install .[dev]
- cd smartredis; python -m pip install .
- cd smartredis/doc; doxygen Doxyfile_c; doxygen Doxyfile_cpp; doxygen Doxyfile_fortran
- ln -s smartredis/examples ./examples
- cd smartdashboard; python -m pip install .
pre_build:
- pip install typing_extensions==4.8.0
- pip install pydantic==1.10.13
- python -m sphinx -b linkcheck doc/ $READTHEDOCS_OUTPUT/linkcheck

# Build documentation in the "docs/" directory with Sphinx
Expand Down
4 changes: 4 additions & 0 deletions doc/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ To be released at some future point in time

Description

- Fix ReadTheDocs build issue
- Promote device options to an Enum
- Update telemetry monitor, add telemetry collectors
- Add method to specify node features for a Slurm job
Expand All @@ -34,6 +35,8 @@ Description

Detailed Notes

- Change type_extension and pydantic versions in readthedocs environment
to enable docs build. (SmartSim-PR537_)
- Promote devices to a dedicated Enum type throughout the SmartSim code base.
- Update the telemetry monitor to enable retrieval of metrics on a scheduled
interval. Switch basic experiment tracking telemetry to default to on. Add
Expand Down Expand Up @@ -74,6 +77,7 @@ Detailed Notes
- Remove previously deprecated behavior present in test suite on machines with
Slurm and Open MPI. (SmartSim-PR520_)

.. _SmartSim-PR537: https://github.com/CrayLabs/SmartSim/pull/537
.. _SmartSim-PR498: https://github.com/CrayLabs/SmartSim/pull/498
.. _SmartSim-PR460: https://github.com/CrayLabs/SmartSim/pull/460
.. _SmartSim-PR512: https://github.com/CrayLabs/SmartSim/pull/512
Expand Down

0 comments on commit d462fd2

Please sign in to comment.