Repository navigation
docs: link the Read the Docs site from README and pyproject - #75
Merged
Merged
Conversation
Point the Documentation project URL and the README "Documentation" and migration links at https://toon-format.readthedocs.io/en/stable/, add a Read the Docs badge, and replace the CONTRIBUTING note that said the project did not exist yet (it was created with the slug toon-format, not toon-python). Refs toon-format#66 (discussion) Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
alesanfra
approved these changes
Oct 5, 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
2 participants
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.
Follows up on the "nice small first task" suggested in discussion #66: link the Read the Docs site (https://toon-format.readthedocs.io/en/stable/) from
pyproject.tomland the README.Changes
pyproject.toml: theDocumentationproject URL now points to Read the Docs instead of thedocs/folder on GitHub. PyPI shows this link in the sidebar.README.md: adds a Read the Docs badge next to the others, and the "Documentation" section and the migration guide link now point to the hosted pages.CONTRIBUTING.md: the release notes said the Read the Docs project "does not exist yet" and listed these exact steps under the planned slugtoon-python. The project was created astoon-format(toon-python.readthedocs.ioreturns 404), so that paragraph is replaced with where the docs live now.All new links return 200. I left
CHANGELOG.mdalone because this is a docs-only link change. Happy to add an Unreleased entry if you prefer one.Checks
uv run ruff check .,uv run ruff format --check .,uv run mypy: passuv run pytest --cov --cov-fail-under=95: 1286 passed, 99.27% coverageuv run --group docs mkdocs build --strict: passuv build: wheel metadata showsProject-URL: Documentation, https://toon-format.readthedocs.io/en/stable/馃 Generated with Claude Code