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.

Sign up for GitHub

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

Jump to bottom

Add guide on executable documentation #157

Open
danielballan opened this issue May 26, 2023 · 1 comment
Open

Add guide on executable documentation #157

danielballan opened this issue May 26, 2023 · 1 comment

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.
@henryiii henryiii mentioned this issue Aug 10, 2023
Merged
@henryiii henryiii mentioned this issue Feb 12, 2024
Merged
@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@danielballan