Now install Python packages to virtual environments.

This commit is contained in:
drwhut 2024-09-04 11:28:30 +01:00
parent 03c5eeb8da
commit b42785de48
3 changed files with 30 additions and 5 deletions

3
.gitignore vendored
View File

@ -19,3 +19,6 @@ game/webrtc/
# OSX ignores # OSX ignores
.DS_Store .DS_Store
# Python ignores
env/

View File

@ -4,11 +4,25 @@ The documentation is built using [Sphinx](https://www.sphinx-doc.org/en/master/)
## Requirements ## Requirements
To build the documentation, you will need to install a few Python packages, To build the documentation, you will first need to create a Python virtual
which you can do with the following command: environment so you can install packages without affecting your system:
```bash ```bash
python3 -m pip install -r requirements.txt python3 -m venv env
```
Then, activate the environment and install the necessary packages:
```bash
source env/bin/activate
pip3 install -r requirements.txt
```
Once you are done building the documentation, you can then use `deactivate` at
any time to exit out of the virtual environment:
```bash
deactivate
``` ```
## Building ## Building
@ -23,7 +37,8 @@ To build the documentation on Windows:
make.bat html make.bat html
``` ```
You can then visit the documentation by opening `_build/html/index.html` in the web browser of your choice. You can then view the documentation by opening `_build/html/index.html` in the
web browser of your choice.
## Cleaning ## Cleaning

View File

@ -1,7 +1,14 @@
#!/bin/bash #!/bin/bash
# NOTE: This script needs to be run within a Python virtual environment (venv):
#
# python3 -m venv env
# source env/bin/activate
# ./extract_pot.sh
# deactivate
# Install the Python packages. # Install the Python packages.
python3 -m pip install -r requirements.txt pip3 install -r requirements.txt
# Extract the .pot file. # Extract the .pot file.
pybabel extract -F babelrc.txt -k text -k LineEdit/placeholder_text -k tr \ pybabel extract -F babelrc.txt -k text -k LineEdit/placeholder_text -k tr \