Fixed issue #204 that caused a Sphinx error - Githubissues

sphinx-contrib / matlabdomain

A Sphinx extension for documenting Matlab code

Other

64 stars 45 forks source link

Fixed issue #204 that caused a Sphinx error #230

Closed joeced closed 8 months ago

joeced commented 8 months ago

entities_table entries can be a dict in case of module name and short class name overlap.
Added a test (tests/roots/[test_module_class_names).

rdzman commented 8 months ago

I haven't looked at all of the details, but I think this is likely incompatible with some auto-linking. For example, there are places where it is assumed that an entities_table entry is a MatObject and specifically that it has a ref_role() method.

Some examples ...

https://github.com/sphinx-contrib/matlabdomain/blob/2fc26b2022f67374a4c7caa291e6f955dc4b2009/sphinxcontrib/mat_documenters.py#L237

https://github.com/sphinx-contrib/matlabdomain/blob/2fc26b2022f67374a4c7caa291e6f955dc4b2009/sphinxcontrib/mat_documenters.py#L274

https://github.com/sphinx-contrib/matlabdomain/blob/2fc26b2022f67374a4c7caa291e6f955dc4b2009/sphinxcontrib/mat_documenters.py#L313