The simulink-diagram directive requires at minimum one argument specifying the Simulink system:
.. simulink-diagram:: SystemAdditional 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/DepthDependencies
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.
1 maintainer
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sphinx-simulink-0.0.1.zip.
File metadata
- Download URL: sphinx-simulink-0.0.1.zip
- Upload date:
- Size: 10.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e1f79d3550fffa4b54323c280dcbb46dd535460379b3f4f1d3c48e623f8f2637
|
|
| MD5 |
937ae17c559a7bd4b03dd905a001ab29
|
|
| BLAKE2b-256 |
ec62e90b4980ed7c7215f7dff68b0906ffa5be3cb8bff32acc2b0834adab6a46
|
File details
Details for the file sphinx_simulink-0.0.1-py3-none-any.whl.
File metadata
- Download URL: sphinx_simulink-0.0.1-py3-none-any.whl
- Upload date:
- Size: 7.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
03098257bd1116bbec37f60a97d270d17f69aaa2e7b55496457f7b4c77ca4468
|
|
| MD5 |
6cda7213ecc83a40f9cfc07d022d2e4b
|
|
| BLAKE2b-256 |
9f782e4bceea1acb8302815ba28c04c63357eb9f3e6e51df4df80dd5f0531fdd
|
