Skip to content

Commit

Permalink
DOC: Add notebook test option description to README
Browse files Browse the repository at this point in the history
  • Loading branch information
tbirdso committed Jan 5, 2023
1 parent ac22a30 commit a79a8ed
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,18 @@ to direct workflow execution.
manylinux-platforms: '["_2_28-x64","2014-x64","_2_28-aarch64"]'
```

- `test-notebooks`: Boolean option to test Jupyter Notebook examples located in the
`examples/` directory of the external module. A `requirements.txt` file
should be provided in either the external module root or `binder/` directories
to indicate notebook prerequisites for testing. Default value is `false`, notebook
tests may be enabled for a repository containing notebook examples by setting
the value to `true`.

```yaml
with:
test-notebooks: true
```

## Contributing

Community contributions to `ITKRemoteModuleBuildTestPackageAction` are welcome!
Expand Down

0 comments on commit a79a8ed

Please sign in to comment.