Skip to content

Commit 9d67010

Browse files
Add link to pyproject-api docs as example of this extension (#267)
* Add link to pyproject-api docs as example of this extension * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Change urls.Homepage to this repo url Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent cec0441 commit 9d67010

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,10 @@ versions](https://img.shields.io/pypi/pyversions/sphinx-autodoc-typehints.svg)](
77
[![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)
88

99
This extension allows you to use Python 3 annotations for documenting acceptable argument types and return value types
10-
of functions. This allows you to use type hints in a very natural fashion, allowing you to migrate from this:
10+
of functions. See an example of the Sphinx render at the
11+
[pyproject-api docs](https://pyproject-api.readthedocs.io/en/latest/).
12+
13+
This allows you to use type hints in a very natural fashion, allowing you to migrate from this:
1114

1215
```python
1316
def format_unit(value, unit):

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ readme.file = "README.md"
99
readme.content-type = "text/markdown"
1010
keywords = ["virtual", "environments", "isolated", "testing"]
1111
license = "MIT"
12-
urls.Homepage = "http://pyproject_api.readthedocs.org"
12+
urls.Homepage = "https://github.com/tox-dev/sphinx-autodoc-typehints"
1313
urls.Source = "https://github.com/tox-dev/sphinx-autodoc-typehints"
1414
urls.Tracker = "https://github.com/tox-dev/sphinx-autodoc-typehints/issues"
1515
urls.Changelog = "https://github.com/tox-dev/sphinx-autodoc-typehints/blob/main/CHANGELOG.md"

0 commit comments

Comments
 (0)