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;
        feel/free/to/split/across/lines;C:/And/With/Absolute/Paths
    :preload: optional_preload.m
    :subsystem: SubsystemLayerInModel/At/Any/Depth

Dependencies

Ensure you install the following into your Python environment:

Example

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.

Files for sphinx-simulink, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size sphinx_simulink-0.0.1-py3-none-any.whl (7.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size sphinx-simulink-0.0.1.zip (10.9 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page