Skip to content

Commit ad9877c

Browse files
committed
Add documentation links
1 parent 61b95c7 commit ad9877c

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# setuptools_scm
22
[![github ci](https://github.com/pypa/setuptools_scm/workflows/python%20tests+artifacts+release/badge.svg)](https://github.com/pypa/setuptools_scm/actions)
3+
[![Documentation Status](https://readthedocs.org/projects/setuptools-scm/badge/?version=latest)](https://setuptools-scm.readthedocs.io/en/latest/?badge=latest)
34
[![tidelift](https://tidelift.com/badges/package/pypi/setuptools-scm) ](https://tidelift.com/subscription/pkg/pypi-setuptools-scm?utm_source=pypi-setuptools-scm&utm_medium=readme)
45

56
## about
@@ -60,14 +61,16 @@ Where `pkg` is the name of your package.
6061
If you need to confirm which version string is being generated or debug the configuration,
6162
you can install [setuptools-scm] directly in your working environment and run:
6263

63-
[setuptools-scm]: https://github.com/pypa/setuptools_scm
64-
6564
```console
6665
$ python -m setuptools_scm
6766
# To explore other options, try:
6867
$ python -m setuptools_scm --help
6968
```
7069

70+
For further configuration see the [documentation].
71+
72+
[setuptools-scm]: https://github.com/pypa/setuptools_scm
73+
[documentation]: https://setuptools-scm.readthedocs.io/
7174

7275

7376
## Interaction with Enterprise Distributions

pyproject.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,11 @@ test = [
6363
]
6464
toml = [
6565
]
66+
6667
[project.urls]
6768
repository = "https://github.com/pypa/setuptools_scm/"
69+
documentation = "https://setuptools-scm.readthedocs.io/"
70+
6871
[project.entry-points."distutils.setup_keywords"]
6972
use_scm_version = "setuptools_scm._integration.setuptools:version_keyword"
7073
[project.entry-points."setuptools.file_finders"]

0 commit comments

Comments
 (0)