mystmd icon indicating copy to clipboard operation
mystmd copied to clipboard

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

Open choldgraf opened this issue 1 year ago • 3 comments

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 avatar Apr 16 '24 23:04 choldgraf

Yep, was going to suggest this!

rowanc1 avatar Apr 16 '24 23:04 rowanc1

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:

  • #982

choldgraf avatar Apr 16 '24 23:04 choldgraf

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.

choldgraf avatar Apr 17 '24 01:04 choldgraf

This has been implemented!

rowanc1 avatar May 08 '24 17:05 rowanc1