Skip to content

Commit

Permalink
Added .env.template
Browse files Browse the repository at this point in the history
  • Loading branch information
PierreRaybaut committed Nov 23, 2023
1 parent 9100624 commit 9275173
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 2 deletions.
File renamed without changes.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ doc/extras_require-dev.txt
doc/extras_require-doc.txt
*.bak

# Visual Studio Code
.venv
.env

# Created by https://www.gitignore.io/api/python

### Python ###
Expand Down
12 changes: 10 additions & 2 deletions dev/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ still under development (or for confidential data).
Specific environment variables
------------------------------

Enable the "debug" mode (no stdin/stdout redirection towards internal console) :
Enable the "debug" mode (no stdin/stdout redirection towards internal console):

@REM Mode DEBUG
set DEBUG=1

Adding support for mathematical equations in documentation:
Building PDF documentation requires LaTeX. On Windows, the following environment:

@REM LaTeX executable must be in Windows PATH, for mathematical equations rendering
@REM Example with MiKTeX :
Expand All @@ -49,6 +49,14 @@ Visual Studio Code configuration used in `launch.json` and `tasks.json`
@REM Folder containing additional working test data
set CDL_DATA=C:\Dev\Projets\CDL_data

Visual Studio Code `.env` file:

* This file is used to set environment variables for the application.
* It is used to set the `PYTHONPATH` environment variable to the root of the project.
* This is required to be able to import the project modules from within VS Code.
* To create this file, copy the `.env.template` file to `.env`
(and eventually add your own paths).

Other requirements
------------------

Expand Down

0 comments on commit 9275173

Please sign in to comment.