Sphinxcontrib-matlabdomain

Latest version: v0.22.1

Safety actively analyzes 682244 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 2 of 11

0.21.1

==============================================

* Fixed `Issue 204`_, that caused an ``AttributeError`` to be thrown if a module
was named the same as the short name for a class.

.. _Issue 204: https://github.com/sphinx-contrib/matlabdomain/issues/204

0.21.0

==============================================

* Allow ``matlab_src_dir`` to be a relative path of the ``conf.py`` file. See
`PR 224`_ and `PR 225`_.
* Fixed `Issue 220`_. Parsing of property docstring could throw warning if there
were blank lines between comments.
* Fixed `Issue 221`_. Using builtin's in class folder defintion for methods
defined in other files, threw a parsing warning.
* Fixed `Issue 225`_. Empty ``classfolder`` would throw an assertion error.

.. _Issue 220: https://github.com/sphinx-contrib/matlabdomain/issues/220
.. _Issue 221: https://github.com/sphinx-contrib/matlabdomain/issues/221
.. _Issue 225: https://github.com/sphinx-contrib/matlabdomain/issues/225
.. _PR 224: https://github.com/sphinx-contrib/matlabdomain/pull/224
.. _PR 225: https://github.com/sphinx-contrib/matlabdomain/pull/225

0.20.2

==============================================

* Fixed `Issue 214`_ again. Any folder below a ``classfolder`` must be ignored.

0.20.1

==============================================

* Fixed `Issue 214`_. After fixing `Issue 56`_, we introduced a bug parsing
``private`` folders incorrectly.

.. _Issue 214: https://github.com/sphinx-contrib/matlabdomain/issues/214

0.20.0

==============================================

* Fixed `Issue 188`_ and `Issue 189`_, which caused the extension to crash if
the documentation contained ``:exclude-members:``.
* Added a new configuration: ``matlab_auto_links``. It will automatically
convert the names of known entities (e.g. classes, functions, properties,
methods) to links! This means that we can write class documentation as `MATLAB
Class Help`_ suggests. Including property and methods lists in the class
docstring.
* Fixed `Issue 56`_. `MATLAB Folder Class definitions`_, i.e. prefixed with
`, are now treated as normal classes. All methods defined in the class
defintion and in files in the `-folder are availble. Further, it can
referenced by a shortened name. Before you had to explicity write out the
"module", class and methods. Now you can just write the class name. Only
caveat is that `Issue 44`_ still applies.

.. _Issue 44: https://github.com/sphinx-contrib/matlabdomain/issues/44
.. _Issue 56: https://github.com/sphinx-contrib/matlabdomain/issues/56
.. _Issue 188: https://github.com/sphinx-contrib/matlabdomain/issues/188
.. _Issue 189: https://github.com/sphinx-contrib/matlabdomain/issues/189
.. _MATLAB Class Help: https://mathworks.com/help/matlab/matlab_prog/create-help-for-classes.html
.. _MATLAB Folder Class definitions: https://mathworks.com/help/matlab/matlab_oop/organizing-classes-in-folders.html

0.19.1

==============================================

* Fix parsing of classes with trailing ``;`` after ``end``
* Fix bug if extension is included, but ``matlab_src_dir`` is not set.

Page 2 of 11

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.