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:
Sphinx (see http://www.sphinx-doc.org)
matlab.engine (see MathWorks documentation, first introduced in R2014B)
Example
Please look in this repository’s “example” folder for an example.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinx_simulink-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 03098257bd1116bbec37f60a97d270d17f69aaa2e7b55496457f7b4c77ca4468 |
|
MD5 | 6cda7213ecc83a40f9cfc07d022d2e4b |
|
BLAKE2b-256 | 9f782e4bceea1acb8302815ba28c04c63357eb9f3e6e51df4df80dd5f0531fdd |