Merge pull request #499 from RonnyPfannschmidt/fix-142-document-supported-scms

Fix 142 document supported scms

Author: RonnyPfannschmidt

CHANGELOG.rst

@@ -10,6 +10,7 @@ v4.2.0
 * enhance documentation
 * consider SOURCE_DATE_EPOCH for versioning
 * add a version_tuple to write_to templates
+* fix #142: clearly list supported scm
 
 
 v4.1.2

README.rst

@@ -9,6 +9,13 @@ Additionally ``setuptools_scm`` provides setuptools with a list of files that ar
 (i.e. it automatically adds all of the SCM-managed files to the sdist).
 Unwanted files must be excluded by discarding them via ``MANIFEST.in``.
 
+``setuptools_scm`` support the following scm out of the box:
+
+* git
+* mercurial
+
+
+
 .. image:: https://github.com/pypa/setuptools_scm/workflows/python%20tests+artifacts+release/badge.svg
     :target: https://github.com/pypa/setuptools_scm/actions
 

setup.cfg

@@ -8,7 +8,7 @@ author = Ronny Pfannschmidt
 author_email = [email protected]
 description = the blessed package to manage your versions by scm tags
 long_description= file:README.rst
-
+long_description_content_type=text/x-rst
 
 classifiers=
     Development Status :: 5 - Production/Stable

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist=py{27,34,35,36,37,38,39}-test,flake8,check_readme,py{27,37}-selfcheck
+envlist=py{27,34,35,36,37,38,39}-test,flake8,check_readme,check-dist,py{27,37}-selfcheck,docs
 
 [pytest]
 testpaths=testing
@@ -46,21 +46,21 @@ commands =
 skip_install=True
 setenv = SETUPTOOLS_SCM_PRETEND_VERSION=2.0
 deps=
-    readme
     check-manifest
+    docutils
 commands=
-    python setup.py check -r
     rst2html.py README.rst {envlogdir}/README.html --strict []
     check-manifest
 
-[testenv:upload]
+[testenv:check_dist]
 deps=
     wheel
     twine
 commands=
-    python setup.py clean --all rotate -k - -m .whl,.tar.gz,.zip
+    python setup.py clean --all rotate -k 0 -m .whl,.tar.gz,.zip
     python setup.py -q egg_info
-    python setup.py -q sdist --formats zip bdist_wheel register
+    python setup.py -q sdist --formats zip bdist_wheel
+    twine check dist/*