[codex] Add Read the Docs documentation#17
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #17 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 1 1
Lines 198 198
=========================================
Hits 198 198 ☔ View full report in Codecov by Sentry. |
658cfc6 to
f5311be
Compare
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.
Summary
Adds Read the Docs support and a Sphinx documentation site for
alternative.This includes:
.readthedocs.yamlconfigured for the existinguvworkflowdocs/covering quickstart, runtime workflow, pytest integration, and API referencepyproject.tomland matchinguv.lockupdatesAGENTS.mdguidance to keep docs current and warning-freeCI fix
The docs stage initially failed because
astral-sh/setup-uv@v1installed auvversion whoseuv rundid not support--group. The workflow now uses the current setup actions and syncs the docs group explicitly:actions/checkout@v6actions/setup-python@v6astral-sh/setup-uv@v8.1.0uv sync --dev --group=docsValidation
Ran from a clean worktree based on
origin/master:uv sync --dev --group=docsuv run --dev ruff format --check --diff .uv run --dev ruff check .uv run --dev pyrefly check .uv run --dev mypy .uv run --dev pytest --verbosity=2 --cov=alternative --cov-report=xml --cov-fail-under=100 --junit-xml=test-results.xmluv run --group=docs sphinx-build --fail-on-warning --keep-going --builder=html docs /tmp/alternative-docs-htmlTests passed: 37 passed, 100% coverage. Docs build passed without warnings.