Repository navigation
Osteosarc 0.2.6
Reorganized documentation that puts the main features and key concepts first. No library behavior changes from 0.2.5.
python -m pip install --upgrade osteosarc==0.2.6- README (#32): now a short landing page (it's also the PyPI description) with a feature list, a Python and CLI quickstart, and a table of guides.
- Docs home: opens with what the library does. A callout notes that the 32 source corrections are on by default and are checked against each snapshot's sources.
- New pages:
- Key concepts: sample IDs, variant status, a table of coordinate conventions, corrections, and how missing values are marked.
- A command-line guide covering every command and the interactive explorer.
- A changelog.
- API reference and fixtures: the API reference now covers every exported name, including the fixture, bundle, recovery, record-identity and SV catalogue APIs. The fixtures guide opens with a runnable recipe. Read recovery is documented with the other read-extraction options.
- Docs checks (#31):
- The example checker runs every page in the site nav. Previously, three pages had never been run.
- The strict build validates
#anchorlinks. - Two examples that had never run are fixed. The per-sample panel loop now skips alignments published without an index, and is marked as a batch job because it takes over an hour.
- Existing documentation URLs are unchanged.
Validation:
- CI passes on Python 3.9–3.13, including Varcode 7/9 consumer checks.
- 245 tests pass against the built wheel in a clean virtualenv.
- All documentation examples pass against live osteosarc.com sources, except the long per-sample batch example, which is marked as skipped.
Documentation · PyPI · PR #34