matlabdomain
matlabdomain copied to clipboard
A Sphinx extension for documenting Matlab code
I have stumbled across a very strange bug with certain `:func:` and `:class:` references not working. That is, references like ... ``` :func:`myfunction` :class:`myclass` ``` ... will display correctly, but...
fix bug
Fixed Bug ```console AttributeError: 'NoneType' object has no attribute 'attrs' ``` when using `:members:` for sophisticated class
I believe this is a bug. With `matlab_short_links = True` I would expect to be able to change this (from [this test file](https://github.com/sphinx-contrib/matlabdomain/blob/481134f80be0c84ba1a7c17347d3aefc7a82716d/tests/roots/test_autodoc/index_classfolder.rst)) ... ``` classfolder ----------- .. autoclass:: [email protected]...
Hi @joeced, great work on maintaining this repo. A year ago, I wanted to contribute to support [argument blocks](https://mathworks.com/help/matlab/matlab_prog/function-argument-validation-1.html). However, I've found that the logic in `mat_types.py` based on the...
Abstract methods – which have a signature but not a body – are currently not documented. It would be nice to be able to document them though, since they exist...
Given a module named `foo` and a function within that module, also named `foo`, with `matlab_short_links = True`, it is not possible to create a working link to the function....
Given a class `MyClass` with a method `my_method()`, it does not seem possible to create a link to the method with just the method name (e.g. using ``:meth:`my_method` ``). Rather...
We failed to parse this correctly ``` classdef ConanInterface < handle properties(Abstract, SetAccess=protected) remotes; active_remote; conan_home; remotes_json; db_file; settings_file; end methods(Abstract) % Support functions generateConanfile(dir, package_info) full_package_info = getFullPackageInfo(build_info, package_info)...
In the spirit of #159, it would be nice to not only be able to show the default values, but also show property dimensions, class and validators. That is, simply...
The code might be redundant. The summary table is not completed. Any comments and suggestions are very welcome!