Skip to content

Fix mkdocs build integration with readthedocs (fixes #4345)#4946

Merged
jmiranda merged 1 commit intodevelopfrom
fix-rtd-integration
Nov 16, 2024
Merged

Fix mkdocs build integration with readthedocs (fixes #4345)#4946
jmiranda merged 1 commit intodevelopfrom
fix-rtd-integration

Conversation

@jmiranda
Copy link
Member

✨ Description of Change

Link to GitHub issue or Jira ticket:
#4345

Description:

Readthedocs integration has been failing on all branches derived from develop for a long time. That leads to a failing build check for every PR that gets created.

image

Here's what the build on readthedocs looks like.
image

We fixed the issue months ago, but it's on a long-lived feature branch (OBPIH-6197) aimed at updating our docs for the 0.9.x release. And unfortunately, those change have not been pushed to develop yet.

So here we are.

And here's a recent build of the current branch on readthedocs, showing that the changes allows builds to pass successfully.

image

@jmiranda jmiranda changed the title #4345 Long overdue fix for mkdocs build integration with readthedocs Fix mkdocs build integration with readthedocs (fixes #4345) Nov 16, 2024
@jmiranda jmiranda merged commit 874842b into develop Nov 16, 2024
@jmiranda jmiranda deleted the fix-rtd-integration branch November 16, 2024 06:04
@jmiranda jmiranda linked an issue Nov 16, 2024 that may be closed by this pull request
@codecov
Copy link

codecov bot commented Nov 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 7.62%. Comparing base (69f0dd5) to head (5e0cf06).
Report is 81 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff              @@
##             develop   #4946      +/-   ##
============================================
- Coverage       7.63%   7.62%   -0.01%     
+ Complexity       812     810       -2     
============================================
  Files            598     598              
  Lines          42194   42194              
  Branches       10261   10261              
============================================
- Hits            3220    3216       -4     
- Misses         38509   38515       +6     
+ Partials         465     463       -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@awalkowiak
Copy link
Collaborator

Screenshot from 2024-11-18 09-47-20
🎉

@jmiranda
Copy link
Member Author

Huzzah

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.

Fix mkdocs build integration with readthedocs

2 participants