Sphinxcontrib-matlabdomain

Latest version: v0.22.1

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

Scan your dependencies

Page 3 of 11

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

0.17.1

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

* Fix issue with incorrect parsing of baseclasses with trailing comments.
Reported in `Issue 172 <https://github.com/sphinx-contrib/matlabdomain/issues/172>`_.

0.17.0

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

* Replace ``directive.warn`` (deprecated) with ``logger.warning``. Reported in
`Issue 166 <https://github.com/sphinx-contrib/matlabdomain/issues/166>`_.
* Fix property validation parsing reported in
`Issue 167 <https://github.com/sphinx-contrib/matlabdomain/issues/167>`_.
* Updated Author to Jørgen Cederberg as agreed in
`Issue 164 <https://github.com/sphinx-contrib/matlabdomain/issues/164>`_.

0.16.0

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

* Add new option, ``matlab_show_property_default_value``. Default is now to not
show property values. If a property value is ``None``, is not shown anymore.

0.15.2

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

* Fix issue with not parsing property docstrings correctly with Pygments 2.13.
`Issue 152 <https://github.com/sphinx-contrib/matlabdomain/issues/152>`_.

Page 3 of 11

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.