[Feature]: Make clickable paths to .uml files (for the uml directive) about esbonio HOT 2 OPEN

I assume that the .. uml:: directive is from the sphinxcontrib-plantuml extension?

I definitely want to make sure that it is possible to support this. However, I won't be adding support for this directly to esbonio itself.

Since roles and directives can do practically anything, esbonio needs to be "taught" how each role/directive behaves and what features it should try and provide. So while it makes sense for esbonio support whatever Sphinx provides, it would be impractical to try and add built-in support for the wider ecosystem.

For this reason I've always intended for esbonio to be extensible and my hope is with the upcoming 1.0 release this will finally become a reality. To cut a long story short, my aim is in the worst case scenario you would have to add a few lines to your conf.py to "teach" esbonio about the .. uml:: directive

def setup(app):
    """This is just a sketch, I'm sure the details will change!"""
    if hasattr(app, 'esbonio'):
        app.esbonio.register_directive("uml", argument_provider='filepath')

Best case, the 1.0 release is a huge success and extensions themselves start including the necessary integrations with esbonio and everything Just Works^TM out of the box! 😅

Anyway, I'm going to need an API like this myself in order to re-implement features like this for the 1.0 release so you can be reasonably confident that a solution you can try will be available in a reasonable time frame :)

from esbonio.

Hi @alcarney ,

Yes, you are correct; this directive pertains to the sphinxcontrib-plantuml extension.

Thank you for your engagement and interest in this feature. I hope this feature will be implemented in the future.

Wishing you great success!

from esbonio.