What's a good sphinx API into sphinx-ink?

[choldgraf]

Hey @rowanc1 - I was thinking a bit about how Sphinx could utilize your ink-components framework for interactive documents (that would be the first step to get it into jupyter book). I decided to make a little repo that could be used for iteration and exploration. (if this seems to be a good idea in general, I'd probably move it to the executablebooks organization)

Here's a quick proof-of-concept that we can easily load the components with raw HTML, as well as one idea for how the API would work:

https://choldgraf.github.io/sphinx-ink/

Any interest in iterating on this a little bit with me? I'd love to brainstorm ways that we could expose the functionality into ink components using things like roles/directives. I think for roles it is pretty straightforward, but directives will be trickier because they tend to not be as easily-parameterized. Would be curious to hear your thoughts.

[rowanc1]

Interesting. I think this could also be a way to add some of the interactive citations stuff potentially as well. I am a bit rusty on my sphinx, so will take me a few days to get up to speed. Maybe we could meet later this week or next?

sphinx-explorable might be a better name? Nodding to the explorable exploration community?

[choldgraf]

Ah yeah that makes sense - I had thought you were going with the "ink components" branding which is why I went with "ink" here. +1 to sphinx-explorable

[choldgraf]

OK I've just updated the docs here to the new name, and also updated the example so it uses your new syntax for the components. Let me know if you wanna walk through Sphinx a little bit...I have been knee-deep in sphinx for a few months now haha

[rowanc1]

That is awesome - I think that the sphinx-explorable could be quite a good contribution to the python/docs community and would love to be involved in that as it evolves. I would love to chat again, maybe get your thoughts on where this could fit in and potentially sketch a bit of a (realistic) roadmap together. I think the citation issue might also help me get back into python/sphinx. (I have been super deep in the JS stack, gotta get back to my roots!)

I will close the other branding issue over in iooxa now!