search

sphinx-contrib / matlabdomain

A Sphinx extension for documenting Matlab code
http://sphinxcontrib-matlabdomain.readthedocs.io/
Other
70 stars 45 forks source link

Nested functions not shown in output #74

Closed kuykens closed 6 years ago

kuykens commented 6 years ago

We are using nested functions as a more efficient approach to Matlab's classes. I noticed that these nested functions do not get listed in this tool's output. It only picks up the main function name, that's it.

joeced commented 6 years ago

Can you elaborate a bit. A you talking about a package, class folder or something else. Could you show a minimal example?I'm

kuykens commented 6 years ago

Please see attached Sphinx project. The test_data2 folder contains a sample nested function script. The output of sphinx is the following screen shot snippet. The internal method1 and method2 are not listed in the output. We prefer the nested function OOP approach over the Matlab classes as it appears to be more efficient in processing data.

2018-05-17 18:17 GMT+02:00 Jørgen Cederberg notifications@github.com:

Can you elaborate a bit. A you talking about a package, class folder or something else. Could you show a minimal example?I'm

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/sphinx-contrib/matlabdomain/issues/74#issuecomment-389924221, or mute the thread https://github.com/notifications/unsubscribe-auth/APKewTJ7eLK5iVa95KvU16CEiikpdD7Zks5tzaKMgaJpZM4UC8Pr .

joeced commented 6 years ago

Thanks, but I cannot see any attached documents?

joeced commented 6 years ago

I reread the issue and sorry to inform that this is not yet supported. If it were to be supported, it would only be Local Functions as you can access the help string from MATLAB's help system.