search

sphinx-contrib / matlabdomain

A Sphinx extension for documenting Matlab code
http://sphinxcontrib-matlabdomain.readthedocs.io/
Other
69 stars 45 forks source link

Add option `matlab_short_links` #171

Closed joeced closed 1 year ago

joeced commented 1 year ago

Working on getting more MATLAB like rendering and links.

Rather than target.+package.ClassBar, it will displayed and referenced as package.ClassBar.

rdzman commented 1 year ago

Beautiful! I started working on this at the end of last week, but you got much further much more quickly than me. I'll play around with this a bit more and comment as soon as I have anything. But, assuming this works consistently as intended, I'd vote to release it ASAP, as it's a huge step forward. Thanks!

joeced commented 1 year ago

It's going forward. However, as I learn more, I also discover other issues. For instance, linking to baseclasses which seems to be broken. I'm away from a computer for a week from Wednesday, so there will be limited progress.

joeced commented 1 year ago

A short progress report. It's slow and steady getting closer. I can now render objects in the root folder 🥳

billede

However, I still have a few details to iron out around base class linking.

rdzman commented 1 year ago

This is great. Thanks. I've been looking at some of this code with a view to starting work on #178. And I agree that you're making that easier.

joeced commented 1 year ago

@rdzman It's almost ready to merge to master. I need to fix tests asserting class rendering.