Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix rst remnants #958

Merged
merged 1 commit into from
Oct 17, 2023
Merged

Fix rst remnants #958

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 7 additions & 11 deletions docs/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,12 @@ version_file = "pkg/_version.py"
Where ``pkg`` is the name of your package.


.. code-block:: shell

$ python -m setuptools_scm

# To explore other options, try:
$ python -m setuptools_scm --help
```commandline
$ python -m setuptools_scm

# To explore other options, try:
$ python -m setuptools_scm --help
```

## as cli tool

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

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

```python
# contents of package_name/__init__.py
Expand All @@ -119,9 +118,6 @@ except PackageNotFoundError:
pass
```

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


### Usage from Sphinx

Expand Down
Loading