Closed joeced closed 6 years ago
Original comment by Mark Mikofski (Bitbucket: bwanamarko, GitHub: Unknown):
fixes #23 and fixes #35
Original comment by Mark Mikofski (Bitbucket: bwanamarko, GitHub: Unknown):
fixes #23 and fixes #35
Original comment by Sandor Toth (Bitbucket: tothsa, GitHub: Unknown):
Thank you for the help! I realised that when a class is in a @classname folder, it has to added as a module and all class methods in the @classname folder become functions. Is there a way to document the methods of @classname class as methods?
Original comment by Mark Mikofski (Bitbucket: bwanamarko, GitHub: Unknown):
according to matlab docs on methods in separate folders you only need to use a method signature if it is a non-default method:
If you want to use nondefault method attributes for a method implemented in a separate file, you must add the function signature to a methods block with the attribute specification.
IE: like a static method or has any method attributes. Then it won't work with autodoc extension until we tell it to skip those signatures.
Original comment by Mark Mikofski (Bitbucket: bwanamarko, GitHub: Unknown):
You should be able to document class @ folders, see this example from the test data however if you look at the comments in #21 you'll see that the method protocols in the class m-file don't match any protocol that Pygments (the syntax lexer that parses matlab files) recognizes, so someone need to add a regex to the MatObject.parse_mfile
method on line 157 of mat_types
that ignores function protocols in classdef mfiles when the actual method is in a separate file.
Originally reported by: Sandor Toth (Bitbucket: tothsa, GitHub: Unknown)
I tried to document a larger Matlab project using Sphinx and the sphinxcontrib-matlabdomain package. It works fine for a single folder that stores all .m files. However my project contains multiple classes stored in separate folders such as:
I adde the following lines to
conf.py
:And I added the following lines to
index.rst
:I got the following error:
So my question is, is there a way to document multi class Matlab projects where class methods are saved in a folder with name @class?