Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add guide on executable documentation #157

Open
danielballan opened this issue May 26, 2023 · 3 comments
Open

Add guide on executable documentation #157

danielballan opened this issue May 26, 2023 · 3 comments

Comments

@danielballan
Copy link
Collaborator

Following up #136, investigate whether we should recommend:

  • Jupytext
  • the ipython sphinx directive
  • the matplotlib plot directive

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.

@danielballan
Copy link
Collaborator Author

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
Copy link
Collaborator Author

Following up here to mention, belatedly, that I have a self-contained demo repo illustrating some nice patterns for interactive documentation:

  • source in Markdown (not ipynb JSON)
  • auto-generated branch with ipynb JSON
  • published HTML with executed code
  • Binder
  • Jupyter Lite (proof of concept)

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
Copy link
Collaborator Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant