Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

does Sphinx autosummary work with the MATLAB domain? #37

Open
joeced opened this issue Dec 16, 2014 · 7 comments
Open

does Sphinx autosummary work with the MATLAB domain? #37

joeced opened this issue Dec 16, 2014 · 7 comments

Comments

@joeced
Copy link
Collaborator

joeced commented Dec 16, 2014

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.


@joeced
Copy link
Collaborator Author

joeced commented Dec 17, 2014

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.

@joeced
Copy link
Collaborator Author

joeced commented Dec 17, 2014

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

@joeced
Copy link
Collaborator Author

joeced commented Feb 2, 2015

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.

@joeced
Copy link
Collaborator Author

joeced commented Feb 3, 2015

Original comment by Christian Frick (Bitbucket: ChristianFrick, GitHub: Unknown):


Which was the last working version? Is it possible to switch to that one?

@skycaptain
Copy link

Any news on this?

@joeced
Copy link
Collaborator Author

joeced commented Oct 1, 2019

No, sorrry. No news. I have had very little time to work on this project.

@VincentRouanne
Copy link

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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants