Repository navigation
Add reader-oriented docs and executable JSON examples (1.1.1) - #19
Merged
Merged
Conversation
Coverage Report for CI Build 37497226743Coverage remained the same at 89.778%Details
Uncovered ChangesNo uncovered changes found. Coverage RegressionsNo coverage regressions found. Coverage Stats
💛 - Coveralls |
This was referenced Oct 6, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README previously described requirements without installation or a first working JSON round-trip. Add a small documentation site with installation and the dataclass example on the home page, then guides for saving classes/files, nested values and field migration, followed by rendered API reference.
Match PyEnsembl/mhctools typography and writing conventions, keep sidebar groups expanded initially, preserve README anchors, and correct the README's migration-hook spelling. Include a strict build, rendered-link/anchor checks, executable examples and PR/main publication CI. Documentation requirements remain separate from runtime dependencies. Patch bump: 1.1.0 → 1.1.1.
Validation: required format and lint scripts pass; all 42 tests pass; all five documented examples match their printed output; strict build and 134 rendered internal links across six pages pass. Per the user’s instruction, validation uses strict builds, rendered HTML/link checks and execution without browser automation.
The inherited JSON docstrings tracked in #17 are being corrected separately in #18; this PR preserves that work and makes no serialization behavior change. The version bump may need refreshing when either PR lands first.