diff options
| author | Jason R. Coombs <jaraco@jaraco.com> | 2016-06-03 14:46:42 -0400 |
|---|---|---|
| committer | Jason R. Coombs <jaraco@jaraco.com> | 2016-06-03 14:46:42 -0400 |
| commit | 1b4cddca653b6c4c2f9c18fdfaeade1276ee446a (patch) | |
| tree | 354e6805467f2d4993ab95fe02a0e3bdd1ffc620 | |
| parent | f5390e98b426da854838738c86a48b87742e259d (diff) | |
| download | setuptools-scm-1b4cddca653b6c4c2f9c18fdfaeade1276ee446a.tar.gz | |
Correct typo and clarify Sphinx recommended usage. Fixes #88.
| -rw-r--r-- | README.rst | 5 |
1 files changed, 3 insertions, 2 deletions
@@ -35,12 +35,13 @@ To use setuptools_scm just modify your project's setup.py file like this: Programmatic usage ------------------ -In oder to use setuptools_scm for sphinx config +In order to use setuptools_scm for sphinx config, assuming the sphinx conf +is one directory deeper than the project's root, use:: .. code:: python from setuptools_scm import get_version - version = get_version() + version = get_version(root='..', relative_to=__file__) Notable Plugins |