docs: remove autosummary-generated API stubs#879
Conversation
Adds Sphinx doctest Examples sections to DevelopmentCorrelation and ValuationCorrelation. Each example opens with the Mack chain-ladder assumption being tested, prints the full decision signal (statistic, confidence band, and boolean) rather than a single boolean, and ties the result back to the chain-ladder workflow. Refs casact#704
Adds Sphinx doctest Examples section to the BootstrapODPSample class showing basic fit (resampled_triangles_.shape and scale_), downstream stochastic IBNR via Chainladder, and the effect of drop_high on scale_. Uses random_state=42 and n_sims=100 for deterministic, fast output. Refs casact#704
Rewords the paragraph introducing the drop_high=True example to describe it as a leave-one-out sensitivity check on the column maxima rather than outlier removal, since drop_high mechanically removes the column max without any outlier test. Addresses review feedback on casact#836.
Per @henrydingliu review on casact#844: opening paragraph now scoped to the calendar-effect concept; the per-diagonal vs whole-triangle distinction is introduced as a transition between the two testcode blocks. Refs casact#704
…asact#846) These .rst files under docs/library/generated/ are emitted by sphinx.ext.autosummary on every build (autosummary_generate = True in docs/conf.py, driven by the :toctree: generated/ directives in docs/library/api.md). Committing them is redundant and out of sync with the rest of the build. Adds docs/library/generated/ to .gitignore so future builds do not stage them. Refs parent casact#841.
- Drop the jb build internals + duplicate warnings note (kennethshsu) - Rename 'tutorial notebooks' to 'onboarding and Quickstart notebooks' (kennethshsu) - Drop the 'What to edit for which part of the site' table and 'Known issues' section as redundant with the Source files table and casact#841 (kennethshsu)
…missing unit tests.
…stic values for changed options.
docs: add README documenting docs build sources and outputs
Improved docstring and added examples for Development class
[REFACTOR]: Remove repetitive code. Remove dead Python 3.8 code. Add …
…option getters and setters. Deprecate cl.array_backend() and cl.auto_sparse()
first batch of deliverables for friedland reconstruction
[REFACTOR]: Continue work on cl.__init__.py refactor
…erated-stubs # Conflicts: # docs/library/generated/chainladder.Development.rst
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## experimental #879 +/- ##
=============================================
Coverage 87.04% 87.04%
=============================================
Files 86 86
Lines 4986 4986
Branches 646 646
=============================================
Hits 4340 4340
Misses 456 456
Partials 190 190
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
@priyam0k thanks for submitting. could you please update the experimental branch to main and then merge this commit to experimental first? we are trying to make sure any potentially breaking doc changes get a visual review. just in case if we actually deleted something that's being used, i'm not sure missing stub files would generate a test or doc build failure vs just warnings (which we have a lot of currently). |
priyam0k
left a comment
There was a problem hiding this comment.
Sounds good. I don't have write access to casact:experimental, so could a maintainer bring it up to date with main first? Once that's done I'll retarget this PR to experimental and resolve any conflicts on my end.
done |
…move-generated-stubs # Conflicts: # docs/library/generated/chainladder.Development.rst
|
Experimental built successfully after the merge. I have reviewed the updated experimental version and found all pages accounted for. @priyam0k thank you! you are more than welcome to either wait for experimental to be periodically merged into main with other doc changes, submit a PR for experimental, or resubmit a PR from your original branch directly. |
There was a problem hiding this comment.
Thanks for building, reviewing, and merging it into experimental — really appreciate you taking the time to verify all the API pages render. Glad it's in. Happy to help with any follow-up if anything comes up when experimental flows into main.
Summary of Changes
.rststub files underdocs/library/generated/.docs/library/generated/to.gitignore, mirroring the existingdocs/modules/generated/entry one line above.These files are emitted by
sphinx.ext.autosummaryon every docs build (autosummary_generate = Trueindocs/conf.py, driven by the eight:toctree: generated/directives indocs/library/api.md), so committing them is redundant and the committed copies drift out of sync with what Sphinx actually produces.Docs-only; no runtime, config, or public API changes. Rendered HTML site is unchanged — the stubs are regenerated automatically on
jb build ..Related GitHub Issue(s)
docs/README.md, the contributor flow for adding a new API symbol is to editdocs/library/api.md+ the package docstring — never to hand-write a.rststub.Additional Context for Reviewers
Verified
docs/library/generated/*.rstis re-emitted by the build after deletion and is now ignored by git.The
.gitignoreaddition is a single line placed directly under the existingdocs/modules/generated/entry for consistency.No notebooks, conf, or
_toc.ymlreferences point at the deleted files; all references go throughlibrary/api.md's autosummary toctrees.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
Documentation and git hygiene only; API HTML is unchanged and stubs are recreated on
jb build.Overview
Stops tracking Sphinx autosummary stub files under
docs/library/generated/and adds that directory to.gitignore, alongside the existingdocs/modules/generated/entry.The removed
.rstfiles are regenerated on every docs build fromlibrary/api.md; keeping them in git was redundant and let committed copies drift from what Sphinx produces. No runtime or public API changes—contributors still document symbols viaapi.mdand docstrings.Reviewed by Cursor Bugbot for commit 5c4c18a. Bugbot is set up for automated code reviews on this repo. Configure here.