Simulink diagrams embedded in .rst documentation
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
Metadata
1 maintainer
Release files for sphinx-simulink 0.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinx-simulink-0.0.1.zip | 10.9 kB | Without provenance | Details for sphinx-simulink-0.0.1.zip |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinx_simulink-0.0.1-py3-none-any.whl | Python 3 | none | any | Details for sphinx_simulink-0.0.1-py3-none-any.whl |
Total release size: 18.5 kB
Release files / sphinx-simulink-0.0.1.zip
| Download URL | sphinx-simulink-0.0.1.zip |
|---|---|
| Size | 10.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e1f79d3550fffa4b54323c280dcbb46dd535460379b3f4f1d3c48e623f8f2637
|
|
BLAKE2b-256 checksum How to use checksums |
ec62e90b4980ed7c7215f7dff68b0906ffa5be3cb8bff32acc2b0834adab6a46
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / sphinx_simulink-0.0.1-py3-none-any.whl
| Download URL | sphinx_simulink-0.0.1-py3-none-any.whl |
|---|---|
| Size | 7.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
03098257bd1116bbec37f60a97d270d17f69aaa2e7b55496457f7b4c77ca4468
|
|
BLAKE2b-256 checksum How to use checksums |
9f782e4bceea1acb8302815ba28c04c63357eb9f3e6e51df4df80dd5f0531fdd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for sphinx-simulink 0.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
