Configuration Options

Complete reference of all configuration options.

This page provides a comprehensive reference. For a getting-started guide, see Configuration.

Essential Options

Type: List[str]

Required: Yes

Add sphinxcontrib.matlab to your extensions:

extensions = ['sphinxcontrib.matlab', 'sphinx.ext.autodoc']

Type: str

Required: Yes

Default: None

Path to MATLAB source directory:

matlab_src_dir = '/path/to/matlab/src'

Type: str

Default: 'py'

Set to 'mat' to make MATLAB the primary domain:

primary_domain = 'mat'

Type: bool

Default: False

Added in: v0.19.0

Use shorter names in links:

matlab_short_links = True

Type: str or None

Default: None

Added in: v0.21.0

Options: 'basic', 'all', None

Automatically create links:

matlab_auto_link = 'basic'

Type: bool

Default: True

Show + prefix in package names:

matlab_keep_package_prefix = False

Type: bool

Default: False

Added in: v0.17.0

Show default property values:

matlab_show_property_default_values = True