Skip to content

Fix Read the Docs build for ubuntu-24.04#175

Merged
dfm merged 5 commits intomainfrom
copilot/update-ubuntu-version-read-the-docs
Mar 31, 2026
Merged

Fix Read the Docs build for ubuntu-24.04#175
dfm merged 5 commits intomainfrom
copilot/update-ubuntu-version-read-the-docs

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 30, 2026

  • Update .readthedocs.yaml build OS from ubuntu-20.04 to ubuntu-24.04
  • Add cmake and doxygen to apt_packages for ubuntu-24.04
  • Replace deprecated pkg_resources with importlib.metadata in docs/conf.py
  • Fix isort import ordering in docs/conf.py (stdlib before third-party)
Original prompt

Please update the Ubuntu version used on read the docs to at least 24.04 or lts-latest

Copilot AI changed the title [WIP] Update Ubuntu version to 24.04 or lts-latest on read the docs Bump Read the Docs build OS from ubuntu-20.04 to ubuntu-24.04 Mar 30, 2026
Copilot finished work on behalf of dfm March 30, 2026 19:59
Copilot AI requested a review from dfm March 30, 2026 19:59
@dfm
Copy link
Copy Markdown
Member

dfm commented Mar 31, 2026

@copilot it looks like that's failing on read the docs with a different error. Please fix!

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Mar 31, 2026

@copilot it looks like that's failing on read the docs with a different error. Please fix!

Added cmake and doxygen to apt_packages in .readthedocs.yaml (commit 8c23c0a). These are needed on ubuntu-24.04 for scikit-build-core C++ compilation and Doxygen API doc generation respectively — they were likely pre-installed in the ubuntu-20.04 RTD image but aren't in 24.04.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • docs.readthedocs.io
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js (dns block)
  • readthedocs.org
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Copilot finished work on behalf of dfm March 31, 2026 01:34
@dfm
Copy link
Copy Markdown
Member

dfm commented Mar 31, 2026

@copilot i think the problem is that pkg_resources isn't installed

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Mar 31, 2026

@copilot i think the problem is that pkg_resources isn't installed

Replaced pkg_resources with importlib.metadata (stdlib since Python 3.8) in docs/conf.py in commit 3a64a0f.

Copilot AI changed the title Bump Read the Docs build OS from ubuntu-20.04 to ubuntu-24.04 Fix Read the Docs build for ubuntu-24.04 Mar 31, 2026
Copilot finished work on behalf of dfm March 31, 2026 11:07
@dfm
Copy link
Copy Markdown
Member

dfm commented Mar 31, 2026

@copilot please fix the pre-commit errors in conf.py

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Mar 31, 2026

@copilot please fix the pre-commit errors in conf.py

Fixed in 8028a85 — moved the importlib.metadata stdlib import before the third-party sphinx_material import to satisfy isort.

Copilot finished work on behalf of dfm March 31, 2026 13:26
@dfm dfm marked this pull request as ready for review March 31, 2026 16:23
@dfm dfm merged commit b970b72 into main Mar 31, 2026
7 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