Skip to content

AP-25819: Update readthedocs build os to ubunutu 24.04#99

Open
HedgehogCode wants to merge 2 commits intomasterfrom
todo/AP-25819-readthedocs-update
Open

AP-25819: Update readthedocs build os to ubunutu 24.04#99
HedgehogCode wants to merge 2 commits intomasterfrom
todo/AP-25819-readthedocs-update

Conversation

@HedgehogCode
Copy link
Copy Markdown
Contributor

AP-25819 (Update Python API Doc generation at RTD to use Ubuntu 24.04)

AP-25819 (Update Python API Doc generation at RTD to use Ubuntu 24.04)
@HedgehogCode HedgehogCode force-pushed the todo/AP-25819-readthedocs-update branch 3 times, most recently from 85f3b02 to aeb7cd6 Compare April 10, 2026 13:00
Newer versions do not work out of the box but 3.12 is still better than 3.9.

AP-25819 (Update Python API Doc generation at RTD to use Ubuntu 24.04)
@HedgehogCode HedgehogCode force-pushed the todo/AP-25819-readthedocs-update branch from aeb7cd6 to 9425bc2 Compare April 10, 2026 13:02
@sonarqubecloud
Copy link
Copy Markdown

@HedgehogCode
Copy link
Copy Markdown
Contributor Author

@HedgehogCode HedgehogCode marked this pull request as ready for review April 10, 2026 14:19
@HedgehogCode HedgehogCode requested a review from a team as a code owner April 10, 2026 14:19
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the Read the Docs configuration to build the Python API documentation on a newer Ubuntu image and Python runtime, aligning the RTD environment with current tooling.

Changes:

  • Bump RTD build OS from Ubuntu 20.04 to Ubuntu 24.04.
  • Bump RTD Python toolchain from Python 3.9 to Python 3.12.
  • Touch the RTD python.install requirements entry (indentation change).

python:
install:
- requirements: doc/requirements.txt No newline at end of file
- requirements: doc/requirements.txt
Copy link

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

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

In the python: section, the - requirements: ... entry is indented at the same level as install:. In RTD v2 config, python.install is a list, so the dash entry needs to be nested under install:; otherwise YAML parses - requirements as a sibling of install (and the requirements may not get installed / config may be invalid). Please indent the list item one level deeper under install:.

Suggested change
- requirements: doc/requirements.txt
- requirements: doc/requirements.txt

Copilot uses AI. Check for mistakes.
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