Skip to content

Commit ef3ee88

Browse files
Merge pull request #945 from LecrisUT/docs/link
doc: Add documentation links
2 parents 358b1ec + fc74e06 commit ef3ee88

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-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: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ test = [
6363
toml = [
6464
]
6565
[project.urls]
66+
documentation = "https://setuptools-scm.readthedocs.io/"
6667
repository = "https://github.com/pypa/setuptools_scm/"
6768
[project.entry-points."distutils.setup_keywords"]
6869
use_scm_version = "setuptools_scm._integration.setuptools:version_keyword"

0 commit comments

Comments
 (0)