esbonio icon indicating copy to clipboard operation
esbonio copied to clipboard

Working with Sphinx

Open AA-Turner opened this issue 1 year ago • 1 comments

Bore da Alex!

(One must at least make an attempt at Welsh!)

I've recently had this project pointed out to me, and I wanted to drop you a note to ask what Sphinx can do to make integration easier, or what other ways we as the upstream project can support you? I'm also a maintainer for Docutils so if there are any points there, I'd be very happy to hear them.

Thank you for creating such a useful project, and especially one with such lovely documentation -- I hope one day that Sphinx's documentation matches the standard set here!

Thanks, Adam

AA-Turner avatar Sep 27 '23 09:09 AA-Turner

(One must at least make an attempt at Welsh!)

Diolch yn fawr!

To be honest, integrating with Sphinx/docutils has been fairly straightforward so far! They are both so extensible that I can generally hook into what I need to without too much bother. :smile:

However, if I had a magic wand the one thing I'd probably add would be precise line and column location info for doctree elements - though I appreciate that's probably easier said than done! I should also mention that I haven't put much effort yet into seeing if it's something that could be derived from an existing doctree using a transform or similar mechanism.

Thank you very much for the kind words

alcarney avatar Sep 27 '23 22:09 alcarney