Skip to content

Rtd branch fix #741

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kennethshsu merged 9 commits into from
May 7, 2026
Merged

Rtd branch fix #741

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
9d38f17
Update data-tutorial.ipynb
henrydingliu May 7, 2026
28c76d0
Update data-tutorial.ipynb
henrydingliu May 7, 2026
2ef7ab4
Update deterministic-tutorial.ipynb
henrydingliu May 7, 2026
72deb71
Update development-tutorial.ipynb
henrydingliu May 7, 2026
09d8999
Update stochastic-tutorial.ipynb
henrydingliu May 7, 2026
516046c
Update tail-tutorial.ipynb
henrydingliu May 7, 2026
d414987
Update contributing.md
henrydingliu May 7, 2026
80af533
Update README.rst
henrydingliu May 7, 2026
822c052
Removed the /en/ in urls
kennethshsu May 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@
.. |Build Status| image:: https://github.com/casact/chainladder-python/actions/workflows/pytest.yml/badge.svg
:target: https://github.com/casact/chainladder-python/actions/workflows/pytest.yml

.. |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

@cursor cursor Bot May 7, 2026

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

@henrydingliu henrydingliu May 7, 2026

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

@kennethshsu kennethshsu May 7, 2026

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

@henrydingliu henrydingliu May 7, 2026

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

@kennethshsu kennethshsu May 7, 2026

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 io| image:: https://codecov.io/gh/casact/chainladder-python/branch/master/graphs/badge.svg
:target: https://codecov.io/github/casact/chainladder-python?branch=latest
Expand Down Expand Up @@ -50,7 +50,7 @@ We have a dedicated documentation website, where you can find installation instr

Visit `Chainladder-Python on Read the Docs`_.

.. _Chainladder-Python on Read the Docs: https://chainladder-python.readthedocs.io/
.. _Chainladder-Python on Read the Docs: https://chainladder-python.readthedocs.io/stable/

Contributors Working Group
----------------------------
Expand Down
4 changes: 1 addition & 3 deletions docs/getting_started/tutorials/data-tutorial.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@
"source": [
"# Data Preparation\n",
"## Getting Started\n",
"This tutorial focuses on data, including a brief discussion on how to best prepare your data so it works well with the `chainladder` package. \n",
"\n",
"Be sure to make sure your packages are updated. For more info on how to update your pakages, visit [Keeping Packages Updated](https://chainladder-python.readthedocs.io/en/latest/library/install.html#keeping-packages-updated)."
"This tutorial focuses on data, including a brief discussion on how to best prepare your data so it works well with the `chainladder` package. \n"
]
},
{
Expand Down
4 changes: 1 addition & 3 deletions docs/getting_started/tutorials/deterministic-tutorial.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@
"source": [
"# Applying Deterministic Methods\n",
"## Getting Started\n",
"This tutorial focuses on using deterministic methods to square a triangle. \n",
"\n",
"Be sure to make sure your packages are updated. For more info on how to update your pakages, visit [Keeping Packages Updated](https://chainladder-python.readthedocs.io/en/latest/library/install.html#keeping-packages-updated)."
"This tutorial focuses on using deterministic methods to square a triangle. \n"
]
},
{
Expand Down
4 changes: 1 addition & 3 deletions docs/getting_started/tutorials/development-tutorial.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@
"source": [
"# Development Tutorial\n",
"## Getting Started\n",
"This tutorial focuses on selecting the development factors. \n",
"\n",
"Be sure to make sure your packages are updated. For more info on how to update your pakages, visit [Keeping Packages Updated](https://chainladder-python.readthedocs.io/en/latest/library/install.html#keeping-packages-updated)."
"This tutorial focuses on selecting the development factors. \n"
]
},
{
Expand Down
4 changes: 1 addition & 3 deletions docs/getting_started/tutorials/stochastic-tutorial.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@
"source": [
"# Applying Stochastic Methods\n",
"## Getting Started\n",
"This tutorial focuses on using stochastic methods to estimate ultimates. \n",
"\n",
"Be sure to make sure your packages are updated. For more info on how to update your pakages, visit [Keeping Packages Updated](https://chainladder-python.readthedocs.io/en/latest/library/install.html#keeping-packages-updated)."
"This tutorial focuses on using stochastic methods to estimate ultimates. \n"
]
},
{
Expand Down
4 changes: 1 addition & 3 deletions docs/getting_started/tutorials/tail-tutorial.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@
"source": [
"# Extending Development Patterns with Tails\n",
"## Getting Started\n",
"This tutorial focuses on extending the developent patterns beyond the tail. \n",
"\n",
"Be sure to make sure your packages are updated. For more info on how to update your pakages, visit [Keeping Packages Updated](https://chainladder-python.readthedocs.io/en/latest/library/install.html#keeping-packages-updated)."
"This tutorial focuses on extending the developent patterns beyond the tail. \n"
]
},
{
Expand Down
Loading
Loading