Skip to content

Commit 4169977

Browse files
committed
Expand installation section
1 parent e180cce commit 4169977

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

docs/user_guide.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,19 @@
1010

1111
## Installation
1212

13-
While a docstub package is already available on PyPI, we recommend trying out docstub by installing directly from GitHub with
13+
Docstub is available as a [package on PyPI](https://pypi.org/project/docstub/) and can be installed from there with your favorite package manager. E.g.:
1414

1515
```shell
16-
pip install 'docstub [optional] @ git+https://github.com/scientific-python/docstub'
16+
pip install docstub
1717
```
1818

19-
If you want to pin to a certain commit you can append `@COMMIT_SHA` to the repo URL above.
19+
In case you want to check out an unreleased version you can install directly from the repository with:
20+
21+
```shell
22+
pip install docstub @ git+https://github.com/scientific-python/docstub'
23+
```
24+
25+
To pin to a specific commit you can append `@COMMIT_SHA` to the repository URL above.
2026
2127
2228
## Getting started

0 commit comments

Comments
 (0)