matlabdomain

matlabdomain copied to clipboard

Hi all, I recently discovered Doxygen, Sphinx, and sphinxcontrib-matlabdomain. Very excited to apply it for my MATLAB API. I checked out master and ran the make html command in the following directory:

tests/roots/test_pymat_common_root/base

but I noticed that the index.html page for PythonClass.py and MatlabClass.m differ. It seems like the .m script only supports the first line in its docstring when running the make html command.

For the MATLAB API guide I'm writing, I'd like to format my MATLAB docstrings in RST and have them appear the same way they do for the Python RST comments in the snippet up above. Many of my classes and function docstrings are long in my API, and I cannot represent their contents in a single line.

Is it possible to print out docstrings longer than one line in MATLAB for classes and functions when running the make html command? Can I use RST markup to include fields like param, returns, ect so they reflect in the index.html?

Or, can sphinxcontrib-matlabdomain only print out 1 line's worth of docstring info in MATLAB in the index.html page?

I'm using Sphinx v8.2.3 and sphinxcontrib-matlabdomain 0.22.2.dev8+g4b7d0f5.

My apologies if this has been asked before. Thank you!