diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4006e4c..d9a997f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -45,8 +45,5 @@ environments: do not rename them. 4. Create a GitHub release tagged `vX.Y.Z`. The workflow checks that the tag matches the version, runs the tests, builds, and uploads to PyPI. -The documentation is meant to live at , -built by Read the Docs from `.readthedocs.yaml`. That project does not exist -yet: import the repository on readthedocs.org with the slug `toon-python`, then -point the "Documentation" section of `README.md` and the `Documentation` URL in -`pyproject.toml` to it, and add a Read the Docs badge next to the others. +The documentation lives at , built by +Read the Docs (project slug `toon-format`) from `.readthedocs.yaml`. diff --git a/README.md b/README.md index addfe70..c2eff29 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ [![PyPI](https://img.shields.io/pypi/v/toon-format.svg)](https://pypi.org/project/toon-format/) [![Python versions](https://img.shields.io/pypi/pyversions/toon-format.svg)](https://pypi.org/project/toon-format/) [![TOON spec](https://img.shields.io/badge/TOON%20spec-4.1-blue)](https://github.com/toon-format/spec/blob/main/SPEC.md) +[![Documentation](https://readthedocs.org/projects/toon-format/badge/?version=stable)](https://toon-format.readthedocs.io/en/stable/) The official Python implementation of **TOON** (Token-Oriented Object Notation): a compact, human-readable encoding of the JSON data model, designed to save @@ -108,9 +109,9 @@ npx @toon-format/cli data.json --stats # token savings against JSON ## Documentation -The full documentation is in -**[`docs/`](https://github.com/toon-format/toon-python/tree/main/docs)**: usage, -the Python type mapping, the choices the specification leaves to +The full documentation is on +**[Read the Docs](https://toon-format.readthedocs.io/en/stable/)**: +usage, the Python type mapping, the choices the specification leaves to implementations, and Pydantic. ## Migrating from `toon_format` 0.9 @@ -119,7 +120,7 @@ The distribution and the module keep their names, and `encode(value)` and `decode(text)` keep working. Options are now keyword arguments instead of a dictionary, the token helpers and the `toon` command are gone, and the output follows specification 4.1. See the -[migration guide](https://github.com/toon-format/toon-python/blob/main/docs/migration.md). +[migration guide](https://toon-format.readthedocs.io/en/stable/migration/). ## Contributing diff --git a/pyproject.toml b/pyproject.toml index 0660f79..e87ba96 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -30,7 +30,7 @@ classifiers = [ [project.urls] Homepage = "https://toonformat.dev" -Documentation = "https://github.com/toon-format/toon-python/tree/main/docs" +Documentation = "https://toon-format.readthedocs.io/en/stable/" Repository = "https://github.com/toon-format/toon-python" Specification = "https://github.com/toon-format/spec/blob/main/SPEC.md" Changelog = "https://github.com/toon-format/toon-python/blob/main/CHANGELOG.md"