Repository navigation
Build documentation on Read the Docs - #24
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #24 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 1 1
Lines 165 165
=========================================
Hits 165 165 ☔ View full report in Codecov by Harness. |
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.
Add a Read the Docs build using the same Sphinx theme, Python 3.12 environment, and uv documentation group as alternative. The landing page includes README.rst directly; API and documentation-build pages provide the remaining reference material.
The repository now includes .readthedocs.yaml, locked documentation dependencies, documentation links and a badge, and a CI job that rejects Sphinx warnings. Documentation tools require Python 3.12 while the package retains Python 3.9 support. Dependabot updates the documentation lockfile.
Validation: warning-free Sphinx HTML build before and after committing, actionlint, and 40 tests with 106 subtests. All GitHub Actions checks passed before merging. The hosted latest build succeeded from merge commit 22c8437, and Read the Docs marks the public latest version as built.
Documentation: https://python-jsonstore.readthedocs.io/en/latest/. The existing v2.0.0 tag predates these files, so the auto-generated stable version needs a future release containing the documentation setup.