Skip to content

Build documentation on Read the Docs - #24

Merged
Code0x58 merged 1 commit into
masterfrom
codex/readthedocs
Oct 18, 2026
Merged

Code0x58 merged 1 commit into
masterfrom
codex/readthedocs

Conversation

@Code0x58

@Code0x58 Code0x58 commented Oct 18, 2026 •

Copy link
Copy Markdown
Owner

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.

@codecov

codecov Bot commented Oct 18, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (a0665f9) to head (8344616).
✅ All tests successful. No failed tests found.

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.
📢 Have feedback on the report? Share it here.

@Code0x58
Code0x58 merged commit 22c8437 into master Oct 18, 2026
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant