Skip to content

Commit

Permalink
Fix toml examples in the README. (#11)
Browse files Browse the repository at this point in the history
  • Loading branch information
tobiasraabe authored Apr 16, 2022
1 parent 3ff1a80 commit c723524
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ your project folder as well as your pytask configuration file. Then, the content
look like this.

```toml
[pytask]
[tool.pytask.ini_options]
julia_project = "."
```

Expand Down Expand Up @@ -245,12 +245,14 @@ def task_example():
### Configuration

You can influence the default behavior of pytask-julia with some configuration values.
Place them into a `pyproject.toml` file.

**`julia_serializer`**

Use this option to change the default serializer.

```toml
[tool.pytask.ini_options]
julia_serializer = "json"
```

Expand All @@ -260,6 +262,7 @@ Use this option to set the default suffix of the file which contains serialized
dependencies and products and more.

```toml
[tool.pytask.ini_options]
julia_suffix = ".json"
```

Expand All @@ -268,6 +271,7 @@ julia_suffix = ".json"
Use this option to set default options for each task which are separated by whitespace.

```toml
[tool.pytask.ini_options]
julia_options = ["--threads", 2]
```

Expand All @@ -279,13 +283,15 @@ and `Project.toml` is defined in the same directory as the configuration file
`pyproject.toml`, just use a dot.

```toml
[tool.pytask.ini_options]
julia_project = "."
```

If the environment files were in a folder next to the configuration file called
`environment` use

```toml
[tool.pytask.ini_options]
julia_project = "environment"
```

Expand Down

0 comments on commit c723524

Please sign in to comment.