Skip to main content

Sphinx plugin to include MATLAB/Simulink models into .rst

Project description

The simulink-diagram directive requires at minimum one argument specifying the Simulink system:

.. simulink-diagram:: System

Additional options exist, including:

  • dir: the directory containing system

  • addpath: one or more directories containing dependencies needed by the system (if multiple directories, use a semi-colon, e.g. path1;path2;path3)

  • preload: specify a MATLAB script file (.m) to load before opening the system for print

  • subsystem: the layer in the system to navigate and print from

Note: All directories may be specified either as relative to the .rst document or an absolute path. If a list of directories, a mix of both may be employed.

.. simulink-diagram:: System
    :dir: optional/path/to/model
    :addpath: optional/dependency/path;another/path/to/a/dependency;
    :preload: optional_preload.m
    :subsystem: SubsystemLayerInModel/At/Any/Depth


Ensure you install the following into your Python environment:


Please look in this repository’s “example” folder for an example.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution (10.9 kB view hashes)

Uploaded Source

Built Distribution

sphinx_simulink-0.0.1-py3-none-any.whl (7.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page