From ad9877ca94626ab9e0758881142fab29a6e18084 Mon Sep 17 00:00:00 2001 From: Cristian Le Date: Fri, 29 Sep 2023 11:32:22 +0200 Subject: [PATCH 1/2] Add documentation links --- README.md | 7 +++++-- pyproject.toml | 3 +++ 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b18369bf..fc6d8a39 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # setuptools_scm [![github ci](https://github.com/pypa/setuptools_scm/workflows/python%20tests+artifacts+release/badge.svg)](https://github.com/pypa/setuptools_scm/actions) +[![Documentation Status](https://readthedocs.org/projects/setuptools-scm/badge/?version=latest)](https://setuptools-scm.readthedocs.io/en/latest/?badge=latest) [![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) ## about @@ -60,14 +61,16 @@ Where `pkg` is the name of your package. If you need to confirm which version string is being generated or debug the configuration, you can install [setuptools-scm] directly in your working environment and run: -[setuptools-scm]: https://github.com/pypa/setuptools_scm - ```console $ python -m setuptools_scm # To explore other options, try: $ python -m setuptools_scm --help ``` +For further configuration see the [documentation]. + +[setuptools-scm]: https://github.com/pypa/setuptools_scm +[documentation]: https://setuptools-scm.readthedocs.io/ ## Interaction with Enterprise Distributions diff --git a/pyproject.toml b/pyproject.toml index 7a9df4d2..fc583b15 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -63,8 +63,11 @@ test = [ ] toml = [ ] + [project.urls] repository = "https://github.com/pypa/setuptools_scm/" +documentation = "https://setuptools-scm.readthedocs.io/" + [project.entry-points."distutils.setup_keywords"] use_scm_version = "setuptools_scm._integration.setuptools:version_keyword" [project.entry-points."setuptools.file_finders"] From fc74e063748ec8aa4f7b12abfbc18b8e655ab5d9 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Fri, 29 Sep 2023 09:34:37 +0000 Subject: [PATCH 2/2] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- pyproject.toml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index fc583b15..85746f58 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -63,11 +63,9 @@ test = [ ] toml = [ ] - [project.urls] -repository = "https://github.com/pypa/setuptools_scm/" documentation = "https://setuptools-scm.readthedocs.io/" - +repository = "https://github.com/pypa/setuptools_scm/" [project.entry-points."distutils.setup_keywords"] use_scm_version = "setuptools_scm._integration.setuptools:version_keyword" [project.entry-points."setuptools.file_finders"]