Skip to content

Commit 1b4cddc

Browse files
committed
Correct typo and clarify Sphinx recommended usage. Fixes #88.
1 parent f5390e9 commit 1b4cddc

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,13 @@ To use setuptools_scm just modify your project's setup.py file like this:
3535
Programmatic usage
3636
------------------
3737

38-
In oder to use setuptools_scm for sphinx config
38+
In order to use setuptools_scm for sphinx config, assuming the sphinx conf
39+
is one directory deeper than the project's root, use::
3940

4041
.. code:: python
4142
4243
from setuptools_scm import get_version
43-
version = get_version()
44+
version = get_version(root='..', relative_to=__file__)
4445
4546
4647
Notable Plugins

0 commit comments

Comments
 (0)