Sphinxcontrib-matlabdomain

Latest version: v0.21.5

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

Scan your dependencies

Page 2 of 11

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.

0.19.0

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

* Added new configuration: ``matlab_short_links``. Finally, we are getting
closer to render documentation closer to how MathWorks does it. The parsing of
MATLAB functions, clasess, etc. was rewritten. We now parse all MATLAB files
in ``matlab_src_dir``. Further, you can now generate docs for files in the
root folder (something that only worked for packages before).
* We also updated the class rendering to be closer to that of MathWorks. Instead
of putting both properties and methods together, they are now grouped by:
*Constructor Summary*, *Property Summary* and *Method Summary*. Below is an
example of how the ``ClassBar`` from
``tests/roots/test_autodoc/target/+package/ClassBar.m`` was rendered before
and after.

Before

.. image:: docs/render_classes_0.18.0.png
:alt: Rendering of default ``ClassBar.m`` in 0.18.0

After

.. image:: docs/render_classes_0.19.0.png
:alt: Rendering of default ``ClassBar.m`` in 0.19.0

0.18.0

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

* Improved rendering of class property default values when
``matlab_show_property_default_value = True``. Multiline default values are
now truncated to one line. Excessive spacing is removed and values are just
shown verbatim as they were parsed instead of in string.

* Before

.. image:: docs/render_default_values_0.17.1.png
:alt: Rendering default property values in 0.17.1

* After

.. image:: docs/render_default_values_0.18.0.png
:alt: Rendering default property values in 0.18.0

Page 2 of 11

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.