Skip to content

Commit 8b33cb8

Browse files
committed
Adding docs to run doctests.
1 parent fd910da commit 8b33cb8

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

test/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,13 @@
33
## Unit tests
44
To run the Python based unit tests, see the associated documentation in the `unit_tests` directory.
55

6+
## Doc tests
7+
The Python source code has a wide range of doctests that can be used to verify implementation details quickly. To run the Python based doc tests, run:
8+
```bash
9+
$ export PYTHONPATH=<project_source_root_dir>/scripts:<project_source_root_dir>/scripts/parse_tools
10+
$ pytest -v <project_source_root_dir>/scripts/ --doctest-modules
11+
```
12+
613
## Regression tests
714
The run the regression tests with mock host models, build the main project with your test option:
815

0 commit comments

Comments
 (0)