Skip to content

Rtd branch fix#741

Merged
kennethshsu merged 9 commits intomainfrom
rtd_branch_fix
May 7, 2026
Merged

Rtd branch fix#741
kennethshsu merged 9 commits intomainfrom
rtd_branch_fix

Conversation

@henrydingliu
Copy link
Copy Markdown
Collaborator

@henrydingliu henrydingliu commented May 7, 2026

Summary of Changes

resolving any references to the "latest" branch on rtd

Related GitHub Issue(s)

Additional Context for Reviewers


Note

Low Risk
Documentation-only link updates; low risk aside from potentially pointing users to the wrong RTD version if misconfigured.

Overview
Updates documentation URLs to remove RTD latest references: the README badge now targets version=main and the Read the Docs link points to /stable/.

Also trims the “Getting Started” intro text in several tutorial notebooks to drop the outdated package-update link that referenced en/latest.

Reviewed by Cursor Bugbot for commit 822c052. Bugbot is set up for automated code reviews on this repo. Configure here.

removing an old link
removing an old link
removing an old link
removing an old link
changing reference of latest to main
switching out "latest" for main
@henrydingliu henrydingliu requested review from kennethshsu and removed request for kennethshsu May 7, 2026 04:43
Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 80af533. Configure here.

Comment thread README.rst
.. |Documentation Status| image:: https://readthedocs.org/projects/chainladder-python/badge/?version=latest
:target: https://chainladder-python.readthedocs.io/en/latest/?badge=latest
.. |Documentation Status| image:: https://readthedocs.org/projects/chainladder-python/badge/?version=main
:target: https://chainladder-python.readthedocs.io/main/
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

RTD URLs missing /en/ language path prefix

Medium Severity

The new RTD URLs use the format https://chainladder-python.readthedocs.io/main/... but the standard ReadTheDocs URL format (and the format used by every other RTD link in this codebase) includes the /en/ language prefix: https://chainladder-python.readthedocs.io/en/main/.... The project has no single_version mode configured. Dropping /en/ likely results in broken or incorrectly-resolved documentation links.

Additional Locations (1)
Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 80af533. Configure here.

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.

@kennethshsu https://chainladder-python.readthedocs.io/en/main/ is currently erroring out. is that another RTD settings? do we want to enable?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This is because RTD doesn't use the language flag in URL by default anymore, unless multiple languages are used... Do you want to translate this to Chinese? I think we got a lot of users from Spanish speaking countries too haha :)

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.

That's a good question. CAS has international ambitions. We just need funding for an AI tool to translate our docs.

Docs aside, how do we make docstrings multi-lingual?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

One way to do this is to do it on a new branch. There's probably a way to do multiple languages on the same branch and just have the docs build different versions based on a tag, and I'm not sure which one is easier.

This is probably out of scope for now...

@codecov
Copy link
Copy Markdown

codecov Bot commented May 7, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.94%. Comparing base (9358edd) to head (822c052).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #741   +/-   ##
=======================================
  Coverage   85.94%   85.94%           
=======================================
  Files          85       85           
  Lines        4924     4924           
  Branches      637      637           
=======================================
  Hits         4232     4232           
  Misses        491      491           
  Partials      201      201           
Flag Coverage Δ
unittests 85.94% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@kennethshsu
Copy link
Copy Markdown
Collaborator

@henrydingliu I just made some changes to address the problem and all URLs should be resolved now. Can you do a peer review? Or does it need to be someone else because you opened the PR?

@henrydingliu
Copy link
Copy Markdown
Collaborator Author

@henrydingliu I just made some changes to address the problem and all URLs should be resolved now. Can you do a peer review? Or does it need to be someone else because you opened the PR?

yeah i can't review.

@kennethshsu
Copy link
Copy Markdown
Collaborator

@henrydingliu I just made some changes to address the problem and all URLs should be resolved now. Can you do a peer review? Or does it need to be someone else because you opened the PR?

yeah i can't review.

Do you want to just review my commit subsequent to your? Once you ok it I can approve, or we can ask @genedan.

I love how I can just jump on your branch and make more commits though and it ties to the same PR.

@genedan
Copy link
Copy Markdown
Collaborator

genedan commented May 7, 2026

Lol this is like watching two trains get stuck while playing Factorio. I can approve that last commit if you want, I'm assuming you OK'd everything Henry did before.

@kennethshsu
Copy link
Copy Markdown
Collaborator

Yes, I approve :)

@kennethshsu kennethshsu merged commit 94656c9 into main May 7, 2026
9 checks passed
@kennethshsu kennethshsu deleted the rtd_branch_fix branch May 7, 2026 17:13
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.

Readthedocs not building the latest "main"

3 participants