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

Executable code examples in docs #83

Open
TomNicholas opened this issue Apr 13, 2024 · 1 comment
Open

Executable code examples in docs #83

TomNicholas opened this issue Apr 13, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@TomNicholas
Copy link
Member

The main usage docs revolve around code examples, but these are currently just hard-coded in. It would be good to generate these results automatically, and even better if the docs would display the lovely xarray HTML repr instead of the boring string repr.

I'm not sure what the best way to set that up with myst-markdown is. Do I need to rewrite the usage.md page as a jupyter notebook?

@TomNicholas TomNicholas added the documentation Improvements or additions to documentation label Apr 13, 2024
@ayushnag
Copy link
Contributor

Yes, if you use jupyter notebook files they will show the xarray HTML output. They can also be auto executed on compilation: https://jupyterbook.org/en/stable/content/execute.html

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
Projects
None yet
Development

No branches or pull requests

2 participants