Matlab autosummary #211
Matlab autosummary #211
Conversation
* Add autosummary feature in mat_autosummary.py file *.Add an test example in tests folder
| @@ -0,0 +1,8 @@ | |||
| .. autosummary:: | |||
| :toctree: generated/ | |||
| :template: matmodule.rst | |||
There was a problem hiding this comment.
Is there documentation somewhere on when matmodule.rst, matclass.rst, or matbase.rst should be used?
There was a problem hiding this comment.
matmodule.rst, matclass.rst, matbase.rst are used as default template file for modules classes and others. It could be omitted. And users could create their own template files.
I add a simple explaination in the file.
|
Would suggest adding this feature into the overall docs as part of the PR so that this feature is documented on the default docs page, rather than just in the test folder |
Revise template loader.
|
Hi Thanks for the contribution. Can you by any chance make an automated test, akin to https://github.com/sphinx-contrib/matlabdomain/blob/master/tests/test_autodoc.py ? |
|
I can potentially help with this, but don't want to step on any toes... |
The code might be redundant. The summary table is not completed.
Any comments and suggestions are very welcome!