matlabdomain
matlabdomain copied to clipboard
sphinx-contrib
does Sphinx autosummary work with the MATLAB domain?
Originally reported by: Lev Givon (Bitbucket: lebedov, GitHub: lebedov)
I'm trying to generate docs for a toolbox of MATLAB functions, but it doesn't seem that autosummary can find the functions even though I have the base directory correctly set. See this post on StackOverflow for the original question.
- Bitbucket: https://bitbucket.org/bwanamarko/sphinxcontrib-matlabdomain/issue/32
Original comment by Christian Frick (Bitbucket: ChristianFrick, GitHub: Unknown):
Which was the last working version? Is it possible to switch to that one?
Original comment by Mark Mikofski (Bitbucket: bwanamarko, GitHub: Unknown):
Sorry, but evidently the autosummary extension will not work with the present version of sphinxcontrib.matlabdomain. I took a very brief look at it, and it may take a while for me to implement. If anyone else has the time, contributions are welcomed.
Original comment by Lev Givon (Bitbucket: lebedov, GitHub: lebedov):
No exceptions occur when sphinx-build is run; the only item related to autosummary is the following:
#!text
WARNING: [autosummary] failed to import 'mytoolbox.func1': no module named mytoolbox.func1
Original comment by Mark Mikofski (Bitbucket: bwanamarko, GitHub: Unknown):
I will try to take it look at it next year. I haven't tried the autosummary feature before, so hopefully this will be a nice addition to the MATLAB domain.
One thing to try is sphinx-build -vP . _build from your docs folder, which will increase verbosity and run the Python PDB debugger on exception.
First, thanks for the all the work already done on the matlab domain.
As a new user of both sphinx and the matlab domain, I think it would be nice to mention this issue in the Readme, as it seems most sphinx tutorials and usecases assume that autosummary is usable (or apidoc / autogen which seem to depend on autosummary).
