diff --git a/README.md b/README.md index e54d8749..fb8cd3cd 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,10 @@ versions](https://img.shields.io/pypi/pyversions/sphinx-autodoc-typehints.svg)]( [![check](https://github.com/tox-dev/sphinx-autodoc-typehints/actions/workflows/check.yml/badge.svg)](https://github.com/tox-dev/sphinx-autodoc-typehints/actions/workflows/check.yml) This extension allows you to use Python 3 annotations for documenting acceptable argument types and return value types -of functions. This allows you to use type hints in a very natural fashion, allowing you to migrate from this: +of functions. See an example of the Sphinx render at the +[pyproject-api docs](https://pyproject-api.readthedocs.io/en/latest/). + +This allows you to use type hints in a very natural fashion, allowing you to migrate from this: ```python def format_unit(value, unit): diff --git a/pyproject.toml b/pyproject.toml index 51c626f2..c15ef577 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -9,7 +9,7 @@ readme.file = "README.md" readme.content-type = "text/markdown" keywords = ["virtual", "environments", "isolated", "testing"] license = "MIT" -urls.Homepage = "http://pyproject_api.readthedocs.org" +urls.Homepage = "https://github.com/tox-dev/sphinx-autodoc-typehints" urls.Source = "https://github.com/tox-dev/sphinx-autodoc-typehints" urls.Tracker = "https://github.com/tox-dev/sphinx-autodoc-typehints/issues" urls.Changelog = "https://github.com/tox-dev/sphinx-autodoc-typehints/blob/main/CHANGELOG.md"