Repository navigation
Add guide on executable documentation #157
Description
Following up #136, investigate whether we should recommend:
- Jupytext
- the
ipythonsphinx directive - the matplotlib
plotdirective
I suspect that Jupytext is now the best way to do this, and more compatible with a Markdown-based approach, but I want to educate myself more.
Activity
danielballan commentedon Feb 13, 2024
I started looking at this more today, aligned with a day-job task. I intend to put up a PR on this in the next week or so.
danielballan commentedon Nov 11, 2024
Following up here to mention, belatedly, that I have a self-contained demo repo illustrating some nice patterns for interactive documentation:
https://github.com/danielballan/interactive-tutorial-demo
I could imagine promoting this to live in the scientific-python org if there is support and interest.
danielballan commentedon Nov 11, 2024
Given the range of technologies and use cases, I think it would be too heavy to include in this repository, so I would advocate for linking out. Most major projects have a dedicated "examples" repo separate from the main library to do things like this.