Skip to content

Commit 9c64604

Browse files
committed
Automated environment variables documentation generation (CI)
1 parent dc5463a commit 9c64604

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

scripts/ENVIRONMENT_VARIABLES.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,12 @@ This file was generated with the script [appendEnvironmentVariables.sh](./append
66

77
| Environment Variable Name | Default | Description |
88
| ----------------------------------- | ----------------------------------- | ------------------------------------------------------ |
9+
PREPARE_CONDA_ENVIRONMENT | true | Wether to prepare a Python environment with Conda if needed (default, "true") or use an already prepared Conda environment ("false") |
910
JUPYTER_NOTEBOOK_DIRECTORY | ${SCRIPTS_DIR}/../jupyter | Repository directory containing the Jupyter Notebooks |
10-
CONDA_ENVIRONMENT_FILE | ${JUPYTER_NOTEBOOK_DIRECTORY}/environment.yml | Conda (package manager for Python) environment file path |
11+
CONDA_ENVIRONMENT_FILE | ${JUPYTER_NOTEBOOK_DIRECTORY}/../conda-environment.yml | Conda (package manager for Python) environment file path |
1112
CODEGRAPH_CONDA_ENVIRONMENT | codegraph | Name of the conda environment to use for code graph analysis |
12-
PREPARE_CONDA_ENVIRONMENT | true | Wether to prepare a Python environment with Conda if needed (default, "true") or use an already prepared Conda environment ("false") |
13+
USE_VIRTUAL_PYTHON_ENVIRONMENT_VENV | false | Use "venv" for virtual Python environments ("true") or use an already prepared (e.g. conda) environment (default, "false"). |
14+
PYTHON_ENVIRONMENT_FILE | ${ROOT_DIRECTORY}/requirements.txt | Pip (package manager for Python) environment file path |
1315
REPORTS_SCRIPTS_DIRECTORY | reports | Working directory containing the generated reports |
1416
REPORT_COMPILATIONS_SCRIPTS_DIRECTORY | compilations | Repository directory that contains scripts that execute selected report generation scripts |
1517
SETTINGS_PROFILE_SCRIPTS_DIRECTORY | profiles | Repository directory that contains scripts containing settings |

0 commit comments

Comments
 (0)