summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKlaas van Schelven <klaas@vanschelven.com>2019-07-23 22:04:47 +0200
committerKlaas van Schelven <klaas@vanschelven.com>2019-07-23 22:04:47 +0200
commite94d1759fed93f7d3fb986d2c0d4b4551af4f2e0 (patch)
tree039d6e3bb6c6f0fb467652f6138688161ec2a66d
parent8dd71e3d6898e343941330ec741e2da152c2633a (diff)
downloadsetuptools-scm-e94d1759fed93f7d3fb986d2c0d4b4551af4f2e0.tar.gz
Documentation: add example usage of 'write_to_template' parameter
Fix #184
-rw-r--r--README.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index 8762564..bfb54ff 100644
--- a/README.rst
+++ b/README.rst
@@ -318,7 +318,8 @@ Example configuration in ``setup.py`` format:
setup(
use_scm_version={
- 'write_to': 'version.txt',
+ 'write_to': 'version.py',
+ 'write_to_template': '__version__ = "{version}"',
'tag_regex': r'^(?P<prefix>v)?(?P<version>[^\+]+)(?P<suffix>.*)?$',
}
)