Using uv for docs & adding automated docs generating in PR

[kennethshsu]

Summary of Changes

• Migrate RTC to use uv (Dependency gap between RTD build and Github Action #976)
• There's no code changes on GitHub to address [DOC] Ammend Doctest workflow to attach an artifact of the rendered docs in a ZIP file #1151, it's all done on the RTC admin. It's basically setting up a new webhook. See the automated check below, there's no a new "docs/readthedocs.org:chainladder-python" build. ([DOC] Ammend Doctest workflow to attach an artifact of the rendered docs in a ZIP file #1151)

Related GitHub Issue(s)

Closes #976
Closes #1151

Additional Context for Reviewers

The new doc site built this way doesn't seem to have the double search or pancake icon bugs

• I passed tests locally for both code (uv run pytest) and documentation changes (uv run jb build docs --builder=custom --custom-builder=doctest)

---

Note

Low Risk
Tooling-only changes to docs build and RTC install; no application or library runtime code is modified.

Overview
Docs and CI workflow now use uv instead of pip for installing the project with the docs extra and running Jupyter Book builds.

On Read the Docs, readthedocs.yaml replaces pip install with uv sync and the docs extra. Contributor docs in docs/README.md show uv sync --extra docs and uv run --directory docs jb build . from the repo root. The PR template checklist matches that path and adds a “do not edit below” section so the checklist stays consistent.

^{Reviewed by Cursor Bugbot for commit a6fc39e. Bugbot is set up for automated code reviews on this repo. Configure here.}

[github-actions]

Pyright Type Completeness

View the full pyright --verifytypes output for this commit

Project (full chainladder package, at this PR's head): 14.9% of exported symbols fully typed (194 / 1300)

	Known	Ambiguous	Unknown	Total
Project (head)	194	110	996	1300

Other symbols referenced but not exported by chainladder: 13

	Known	Ambiguous	Unknown	Total
Other (head)	3	1	9	13

Symbols without documentation:

• Functions without docstring: 314
• Functions without default param: 0
• Classes without docstring: 10

Patch (exported symbols added or changed by this PR): no exported symbol type-completeness changes detected.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.86%. Comparing base (f48bd83) to head (a6fc39e).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1171      +/-   ##
==========================================
- Coverage   91.27%   90.86%   -0.42%     
==========================================
  Files          91       91              
  Lines        5422     5331      -91     
  Branches      691      677      -14     
==========================================
- Hits         4949     4844     -105     
- Misses        339      347       +8     
- Partials      134      140       +6     

Flag	Coverage Δ
unittests	90.86% <ø> (-0.40%)	⬇️

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

☔ View full report in Codecov by Harness.
📢 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.

[cursor]

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

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

^{Reviewed by Cursor Bugbot for commit 1cc844d. Configure here.}

[genedan]

I see that you're getting those weird codecov failures too. See #1172 for an example where the only files I changed were pyproject.toml and uv.lock.

I'm pretty sure those lines that are marked as misses are actually getting indirectly hit and that this is just a weird a pytest/codecov bug. I guess we'll need to add some tests to directly hit the lines, despite the minor redundancy involved.

[henrydingliu]

@kennethshsu we should make development versions on rtd hidden.

[kennethshsu]

Ya I'm working on it, if you look above in the actions there's actually a RTC build. The webhook isn't working 100% yet and I keep running into errors, trying to resolve.

[henrydingliu]

that's what i mean. that rtd build is not hidden and everyone visiting the docsite can see it.

[kennethshsu]

I see that you're getting those weird codecov failures too. See #1172 for an example where the only files I changed were pyproject.toml and uv.lock.

I'm pretty sure those lines that are marked as misses are actually getting indirectly hit and that this is just a weird a pytest/codecov bug. I guess we'll need to add some tests to directly hit the lines, despite the minor redundancy involved.

Ya this again, I kinda want to increase the threshold again...

[kennethshsu]

that's what i mean. that rtd build is not hidden and everyone visiting the docsite can see it.

This should be fixed now (remember to clear your cache).

[henrydingliu]

@kennethshsu getting this when i try to visit the rtd version for this branch

also, i'm not seeing a fix for #1151 based on the diff

[kennethshsu]

@kennethshsu getting this when i try to visit the rtd version for this branch

Don't go there, click on the link in the checks instead.

also, i'm not seeing a fix for #1151 based on the diff

Ya, I put in the summary that there's no diff on here, it's basically just reading the docs and relink the GitHub webhook on RTC, which is just a fancy way of saying clicking a few buttons in the right order. I only put the ticket here so we can properly track and close out the ticket in the release notes.

[henrydingliu]

o wow, so we can actually get rid of experimental?