Coder Social home page Coder Social logo

Comments (3)

scottyhq avatar scottyhq commented on June 30, 2024 1

I agree think the major drawback of Jupyter Book right now is the discrepancy between rendered notebooks on the website with lots of extra formatting compared to what is possible in Jupyter Lab. Numpy tutorials require only using CommonMark in notebook cells for this reason (https://github.com/numpy/numpy-tutorials#contributing)

My hunch is that the primary mode for consuming this material is on the website rather than Jupyter Lab, except for the case of workshops where everyone is on Jupyter Lab. And during workshops, the focus is on code cells (people can have the website open in another tab for the rendered version).

So I'm in favor of anything that makes for easier navigation on the website. Yet another convenience could be adding https://sphinx-hoverxref.readthedocs.io/en/latest/ https://blog.readthedocs.com/hoverxref-intersphinx.

from xarray-tutorial.

scottyhq avatar scottyhq commented on June 30, 2024

Nice idea @zmoon this would definitely be interesting to try! We're in the midst of a pretty big revamp leading up to a scipy workshop in July, and just switched to jupyterbook so there is a fair amount in flux at the moment.

from xarray-tutorial.

zmoon avatar zmoon commented on June 30, 2024

What do you think about intersphinx references in the text? Would be nice to have the links, and reduced maintenance vs manually putting the links in, though for people running the notebooks in Jupyter the texts becomes a bit uglier.

from xarray-tutorial.

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.