diff --git a/.readthedocs.yaml b/.readthedocs.yaml index c53a58dec..cecdfe3bf 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -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 diff --git a/doc/changelog.rst b/doc/changelog.rst index c72513d04..3e73101e1 100644 --- a/doc/changelog.rst +++ b/doc/changelog.rst @@ -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 @@ -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 @@ -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