Giter VIP home page Giter VIP logo

Comments (2)

alcarney avatar alcarney commented on June 26, 2024

How interesting!

I'd definitely like to see this happen however, I'm not going to be looking at this any time soon, certainly not before the 1.0 release is out. So if someone else wants to take this on please do! I'd be happy to help them figure out the details.

I should also say I'm (probably) not going to accept jupyter-book specific code to support this into Esbonio itself.

The rule of thumb I've been working to is,

  • if it comes in Sphinx itself, Esbonio should support it
  • if it's not in Sphinx, Esbonio should be extensible enough so that it's possible for a 3rd party to provide that support.

(It's probably time I had that written down somewhere! 😅)

Below are some random thoughts I had while looking into this


The differences between Sphinx and Jupyter-Book is minor

Unfortunately.... it might still be different enough to make adding support non-trivial :/

Esbonio does not actually use the sphinx-build cli to control Sphinx, it instead imports Sphinx as a library, overrides/extends a bunch of things and runs the build itself in a long running process.

It looks like jupyter-book build does some of that as well, so I'm not sure what it would take to get the two to play nice with each other... 🤔

However, reading this section of their docs, perhaps it would be possible to write a config export tool to make a jupyter book project "look right" to Esbonio? (This is probably the easiest, but clunky option to get something going in the short term)

If ultimately, the differences are just configuration then it would be possible to have some kind of "middleware" component do the translation and generate the corresponding configuration Esbonio can send across to its sphinx process (would require #785)

from esbonio.

jonathf avatar jonathf commented on June 26, 2024

Interesting. Thanks for looking into it. And thanks for the explaination. It has been interesting to see how you guys interact with Sphinx.

Yeah, and middleware of some sort might be enough if there isn't any parameters or patching that are in conflict. I would take a look at it myself, but I enough on my plate for such a project right now.

from esbonio.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.