API reference tool

Besides this HTML documentation, Expyriment includes a full offline API reference tool which will allow you to browse and search the API offline, using a graphical user interface.

_images/api_reference_tool.png

Usage

To show the API reference tool, call the following from within Python:

expyriment.show_documentation(3)

Alternatively, the API reference tool can be started with the Command line interface:

python -m expyriment.cli -A