Skip to content

Fix read the docs developer documentation#824

Merged
mcbarton merged 1 commit intocompiler-research:mainfrom
mcbarton:Fix-developer-documentation
Mar 13, 2026
Merged

Fix read the docs developer documentation#824
mcbarton merged 1 commit intocompiler-research:mainfrom
mcbarton:Fix-developer-documentation

Conversation

@mcbarton
Copy link
Copy Markdown
Collaborator

@mcbarton mcbarton commented Feb 25, 2026

If you visit the developer documentation link in the readme you'll notice it is currently broken. This is because the read the docs config is currently set to use llvm 16 and for some reason llvm 18 was being installed despite trying to build with llvm 16 (given we haven't supported llvm 16 for a while means the read the docs developer documentation has been broken for a long time). This PR should fix everything by updating the docs build to reference an llvm 20 install.

@mcbarton mcbarton requested a review from vgvassilev February 25, 2026 14:41
@mcbarton
Copy link
Copy Markdown
Collaborator Author

The developer documentation for this PR is working. See https://cppinterop--824.org.readthedocs.build/en/824/build/html/index.html

@mcbarton mcbarton force-pushed the Fix-developer-documentation branch from 409cdaa to cc3e6f9 Compare February 25, 2026 14:45
tools:
python: "3.11"
apt_packages:
- clang-18
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I initially tried clang/llvm 21, but that wasn't available via apt on Ubuntu 24.04 . That is why I choose clang/llvm 20.

@codecov
Copy link
Copy Markdown

codecov bot commented Feb 25, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.72%. Comparing base (4e3e4c2) to head (0849375).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #824   +/-   ##
=======================================
  Coverage   79.72%   79.72%           
=======================================
  Files          11       11           
  Lines        4025     4025           
=======================================
  Hits         3209     3209           
  Misses        816      816           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@mcbarton mcbarton changed the title Fix developer documentation Fix read the docs developer documentation Feb 25, 2026
@mcbarton mcbarton force-pushed the Fix-developer-documentation branch 2 times, most recently from 7bf7d0a to 317c1a2 Compare February 28, 2026 15:56
@mcbarton mcbarton force-pushed the Fix-developer-documentation branch 2 times, most recently from 73281de to 9e9da26 Compare March 11, 2026 09:25
@mcbarton mcbarton requested a review from Vipul-Cariappa March 12, 2026 16:19
@mcbarton mcbarton force-pushed the Fix-developer-documentation branch from 9e9da26 to 0849375 Compare March 12, 2026 16:19
@mcbarton mcbarton requested a review from aaronj0 March 13, 2026 08:59
Copy link
Copy Markdown
Collaborator

@aaronj0 aaronj0 left a comment

Choose a reason for hiding this comment

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

LGTM, Thanks for catching this

@mcbarton mcbarton merged commit 22812bc into compiler-research:main Mar 13, 2026
34 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