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 the inherited-members autodoc option works with the Matlab domain? #98

Closed
denisrosset opened this issue Nov 6, 2019 · 5 comments
Closed

Comments

@denisrosset
Copy link
Contributor

Hi,
still working on the Sphinx integration in RepLAB. Thanks for the work on links for the base classes, now they work!

Adding the inherited-members option to autodoc seems to produce an empty list of methods in the documentation. Is this something that is expected to work, or should I find a workaround?

Best,
Denis

@joeced
Copy link
Collaborator

joeced commented Nov 7, 2019

No, I just tried it. It has not been implemented and I have never used it.

If it's something you really need, you could try and implement it :)

@denisrosset
Copy link
Contributor Author

Ok thanks! Would you mind if I submit a PR to update the documentation in that respect?

@joeced
Copy link
Collaborator

joeced commented Nov 8, 2019

You are welcome to contribute, but where does the documentation mention inherited-members?

@denisrosset
Copy link
Contributor Author

You're right, it doesn't! We ended up adding some preprocessing to our source code to include the inheritance information; it's not online yet, but we'll publish it soon -- I think matlabdomain is a really nice piece of code, but indeed, adding inherited-members opens a whole can of worms.

@denisrosset
Copy link
Contributor Author

(If you wish to close that issue, I'm totally on board. I realize how non-trivial making all these things work is, and what the impedance mismatch between Matlab and Sphinx is)

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

No branches or pull requests

2 participants