Skip to content

Commit b304cf1

Browse files
authored
Fix rst remnants
1 parent 06e0aaf commit b304cf1

File tree

1 file changed

+7
-11
lines changed

1 file changed

+7
-11
lines changed

docs/usage.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,12 @@ version_file = "pkg/_version.py"
3636
Where ``pkg`` is the name of your package.
3737

3838

39-
.. code-block:: shell
40-
41-
$ python -m setuptools_scm
42-
43-
# To explore other options, try:
44-
$ python -m setuptools_scm --help
39+
```commandline
40+
$ python -m setuptools_scm
4541
42+
# To explore other options, try:
43+
$ python -m setuptools_scm --help
44+
```
4645

4746
## as cli tool
4847

@@ -104,9 +103,9 @@ version = get_version(root='..', relative_to=__file__)
104103
### version at runtime
105104

106105
If you have opted not to hardcode the version number inside the package,
107-
you can retrieve it at runtime from PEP-0566_ metadata using
106+
you can retrieve it at runtime from [PEP-0566](https://www.python.org/dev/peps/pep-0566/) metadata using
108107
``importlib.metadata`` from the standard library (added in Python 3.8)
109-
or the `importlib_metadata`_ backport:
108+
or the [`importlib_metadata`](https://pypi.org/project/importlib-metadata/) backport:
110109

111110
```python
112111
# contents of package_name/__init__.py
@@ -119,9 +118,6 @@ except PackageNotFoundError:
119118
pass
120119
```
121120

122-
.. _PEP-0566: https://www.python.org/dev/peps/pep-0566/
123-
.. _importlib_metadata: https://pypi.org/project/importlib-metadata/
124-
125121

126122
### Usage from Sphinx
127123

0 commit comments

Comments
 (0)