https://github.com/gnu-octave/octave-doctest

Doctests for Octave/Matlab
https://github.com/gnu-octave/octave-doctest

Last synced: 2 months ago
JSON representation

Doctests for Octave/Matlab

• Host: GitHub
• URL: https://github.com/gnu-octave/octave-doctest
• Owner: gnu-octave
• License: bsd-3-clause
• Created: 2011-03-24T22:08:08.000Z (about 15 years ago)
• Default Branch: main
• Last Pushed: 2025-09-13T00:49:49.000Z (9 months ago)
• Last Synced: 2025-09-13T01:22:29.470Z (9 months ago)
• Language: MATLAB
• Homepage: https://gnu-octave.github.io/packages/doctest/
• Size: 539 KB
• Stars: 17
• Watchers: 4
• Forks: 4
• Open Issues: 25
• Metadata Files:
  • Readme: README.matlab.md
  • Changelog: NEWS
  • License: COPYING

Awesome Lists containing this project

README

          
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.