Skip to content

Commit 926f6c8

Browse files
authoredJun 28, 2023
remove poetry from contributing guidelines (#101)
1 parent e6d991f commit 926f6c8

File tree

2 files changed

+3
-28
lines changed

2 files changed

+3
-28
lines changed
 

‎CONTRIBUTING.md

+2-27
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Make a virtualenv and activate it:
1818

1919
```shell
2020
python -m venv .venv
21-
. .venv/bin/activate
21+
source .venv/bin/activate
2222
```
2323

2424
Install your local enviroment dependencies
@@ -46,31 +46,7 @@ pytest .
4646
To get started, you will need to install the documentation dependencies from the project root:
4747

4848
```shell
49-
poetry install --extras docs
50-
```
51-
52-
### The quickest way to get started
53-
54-
The following command (run from project root) will launch a live-reloaded session of the
55-
documentation in your browser, effectively combining the steps detailed in the following sections:
56-
57-
```shell
58-
poetry run make -C docs live
59-
```
60-
61-
### Activate the environment
62-
63-
You will need to activate the virtual environment in order to use the dependencies that were
64-
just installed:
65-
66-
```shell
67-
poetry shell
68-
```
69-
70-
Your prompt should now have a prefix, e.g.:
71-
72-
```shell
73-
(pyscript-cli-_y5OiBT8-py3.9) mattkram [~/dev/pyscript-cli] $
49+
pip install -e ".[docs]"
7450
```
7551

7652
### Generate the docs in live mode
@@ -89,7 +65,6 @@ Or, alternately, navigate to the `docs` directory and run:
8965
make live
9066
```
9167

92-
9368
Either of the above commands should launch a live dev server and you will be able to view the
9469
docs in your browser.
9570
As the files are updated, the docs should be refreshed.

‎docs/source/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
# Load the package version from pyproject.toml
2020
with (project_root / "pyproject.toml").open("r") as fp:
21-
version = toml.load(fp)["tool"]["poetry"]["version"]
21+
version = toml.load(fp)["project"]["version"]
2222
release = version
2323

2424

0 commit comments

Comments
 (0)
Please sign in to comment.