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

[DOCS] Define our computational content with markdown and use --execute when building our site #1114

Closed
choldgraf opened this issue Apr 16, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@choldgraf
Copy link
Member

The MyST documentation has a single .ipynb file and assumes that this file has pre-executed content inside. The docs are built without the --execute flag so no computation happens.

I think it would be helpful if we instead converted that to (or added in addition) a markdown file with computation and built the documentation with --execute. This would make it easier to show off functionality like {eval} and {code-block}, and ensure that they work as expected.

@choldgraf choldgraf added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 16, 2024
@rowanc1
Copy link
Member

rowanc1 commented Apr 16, 2024

Yep, was going to suggest this!

@choldgraf
Copy link
Member Author

Cool - I think this could also be accomplished alongside the ReadTheDocs preview issue so that we can preview the computations in our PRs and get a lightweight "integration test for docs" out of it:

@choldgraf
Copy link
Member Author

choldgraf commented Apr 17, 2024

Also just noting that I have no idea how our docs is actually hosted, so it might be a helpful opportunity for @rowanc1 to show how he implements this if we get it implemented outside of the RTD preview.

@rowanc1
Copy link
Member

rowanc1 commented May 8, 2024

This has been implemented!

@rowanc1 rowanc1 closed this as completed May 8, 2024
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

2 participants