-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
23 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
Running Doctest on Matlab | ||
========================= | ||
|
||
The Doctest package finds specially-formatted blocks of example code | ||
within documentation files. It then executes the code and confirms | ||
the output is correct. This can be useful as part of a testing | ||
framework or simply to ensure that documentation stays up-to-date | ||
during software development. | ||
|
||
The package is designed for Octave but aims to be compatible with | ||
Matlab as well. | ||
|
||
See `help doctest` for documention and other information. | ||
|
||
|
||
Installation | ||
------------ | ||
|
||
To install on Matlab, download the `doctest-matlab-x.y.z.zip` file and | ||
unzip it somewhere. Add it to your Matlab path (e.g., with the Matlab | ||
`addpath` command). Type `doctest doctest` to have Doctest test | ||
itself. |