Skip to content

Commit 7a07a52

Browse files
authored
Update virtual environment name in documentation from venv to .venv (#383)
* fix: add `.venv` to `.gitignore` file * docs: change `venv` to `.venv` * docs: separate powershell and command prompt instructions in `Getting Started > Installation" * docs: update `Tutorials > Install your plugin` to use `.venv`, Command Prompt, and PowerShell * fix(docs): fix unrecognized relative link info message
1 parent 60418c0 commit 7a07a52

3 files changed

Lines changed: 28 additions & 12 deletions

File tree

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,7 @@ stubs/*
2121
dist/*
2222
endstone/_version.py
2323
conan_provider.cmake
24+
25+
# Python virtual environment
26+
.venv/**
27+
.venv

docs/getting-started/installation.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,25 +20,31 @@ just delete and recreate the environment. It's trivial to set up:
2020
- Create a new virtual environment with:
2121

2222
```
23-
python3 -m venv venv
23+
python3 -m venv .venv
2424
```
2525
2626
- Activate the environment with:
2727
28-
=== ":fontawesome-brands-windows: Windows"
28+
=== ":fontawesome-brands-windows: Command Prompt"
2929
30-
``` sh
31-
. venv/Scripts/activate
30+
``` cmd
31+
. .venv\Scripts\activate.bat
32+
```
33+
34+
=== ":fontawesome-brands-windows: PowerShell"
35+
36+
``` powershell
37+
. .venv\Scripts\Activate.ps1
3238
```
3339
3440
=== ":fontawesome-brands-linux: Linux"
3541
3642
``` sh
37-
. venv/bin/activate
43+
. .venv/bin/activate
3844
```
3945
4046
41-
Your terminal should now print `(venv)` before the prompt, which is how you
47+
Your terminal should now print `(.venv)` before the prompt, which is how you
4248
know that you are inside the virtual environment that you just created.
4349
4450
- Exit the environment with:

docs/tutorials/install-your-plugin.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,22 +39,28 @@ Before installing your first plugin, you will need to build it.
3939

4040
To do so, you will need the activate the [virtual environment]. Please make sure Endstone is also installed inside the environment.
4141

42-
=== ":fontawesome-brands-windows: Windows"
42+
=== ":fontawesome-brands-windows: Command Prompt"
4343

44-
``` sh
45-
. venv/Scripts/activate
44+
``` cmd
45+
. .venv\Scripts\activate.bat
46+
```
47+
48+
=== ":fontawesome-brands-windows: PowerShell"
49+
50+
``` powershell
51+
. .venv\Scripts\Activate.ps1
4652
```
4753

4854
=== ":fontawesome-brands-linux: Linux"
4955

5056
``` sh
51-
. venv/bin/activate
57+
. .venv/bin/activate
5258
```
5359

5460
You can now enter this “development mode” by performing an [editable installation] inside the virtual environment,
5561
using pip’s `-e/--editable` flag, as shown below:
5662

57-
``` sh title="(venv)"
63+
``` sh title="(.venv)"
5864
pip install --editable .
5965
```
6066

@@ -86,4 +92,4 @@ Before installing your first plugin, you will need to build it.
8692

8793
[editable installation]: https://pip.pypa.io/en/latest/topics/local-project-installs/
8894

89-
[virtual environment]: ../../getting-started/installation/#environment
95+
[virtual environment]: ../getting-started/installation.md#environment

0 commit comments

Comments
 (0)