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

Doc Cleanup: Consider converting tutorial code to MyST markdown #163

Open
dahlend opened this issue Dec 5, 2024 · 0 comments
Open

Doc Cleanup: Consider converting tutorial code to MyST markdown #163

dahlend opened this issue Dec 5, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@dahlend
Copy link
Collaborator

dahlend commented Dec 5, 2024

Currently the tutorial code is written in python, then run and outputs are combined with markdown to build the tutorial HTMLs.

There is another format called MyST which is essentially another form of ipython notebooks, but purely in markdown:
https://myst-parser.readthedocs.io/en/latest/syntax/typography.html#syntax-core

This may be a clean path to removing some of the odd custom code in the tutorial documentation.

@dahlend dahlend added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 5, 2024
@dahlend dahlend changed the title Doc Cleanup: Convert Tutorial code to MyST markdown Doc Cleanup: Consider convert tutorial code to MyST markdown Jan 3, 2025
@dahlend dahlend changed the title Doc Cleanup: Consider convert tutorial code to MyST markdown Doc Cleanup: Consider converting tutorial code to MyST markdown Jan 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant