docs: specify docs build.os #3349
Conversation
Signed-off-by: Terri Oda <terri.oda@intel.com>
Codecov Report
@@ Coverage Diff @@
## main #3349 +/- ##
==========================================
+ Coverage 75.63% 80.82% +5.19%
==========================================
Files 732 734 +2
Lines 11443 11453 +10
Branches 1560 1560
==========================================
+ Hits 8655 9257 +602
+ Misses 2436 1765 -671
- Partials 352 431 +79
Flags with carried forward coverage won't be shown. Click here to find out more. see 26 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
There was a problem hiding this comment.
Requiring 3.8 explicitly may cause doc build failures on some Ubuntu 22.04 installs -- just checking with the below shows 3.10 for me. Can this be changed to python: "3" to allow any Python3 version? Otherwise looks good to match the spec in rtd v2 config.
docker run ubuntu:22.04 bash -c \
'apt-get -y update && apt-get -y install python3 && python3 --version'
I'd been planning to upgrade this in a future commit anyhow (I just didn't want to change too much at once) but you raise a good point. I don't know how the containers readthedocs uses now are set up; it's likely that they still allow 3.8 when set explicitly but that's pretty long in the tooth. I've upgraded it to 3.10 for now. Edit to add: I'm going with 3.10 explicitly rather than just 3 because readthedocs has historically recommended pinning as much as possible for stable doc builds. |
Looks like readthedocs needs a build.os specified in the config file. I should probably also update this to use a more recent version of python but I'm trying to avoid making too many changes at once since it's not easy to test this config file locally.