Cross-Referencing

Learn how to create links between different parts of your documentation.

Automatic Links

With matlab_auto_link enabled, entity names are automatically linked:

# In conf.py
matlab_auto_link = 'basic'  # or 'all'

Use roles to create explicit links:

See :func:`myfunction` for details.
The :class:`MyClass` implements this.
Call :meth:`MyClass.method` to execute.

With matlab_short_links = True, use shorter names:

:class:`MyClass`  instead of  :class:`package.subpackage.MyClass`