Skip to content

Commit

Permalink
Add link to pyproject-api docs as example of this extension (#267)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
ketozhang and pre-commit-ci[bot] authored Nov 2, 2022
1 parent cec0441 commit 9d67010
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down

0 comments on commit 9d67010

Please sign in to comment.