Use myst_nb in docs #148105
Use myst_nb in docs #148105
Conversation
myst_nb is a plugin that: 1) allows rendering of jupyter notebooks in documentation 2) allows execution of code blocks in markdown docs Execution of code blocks in markdown docs may slow down build time. In order to limit the impact: - by default, we do not execute code blocks when run locally. To run them locally, set the PYTORCH_NB_EXECUTE=1 envvar - code blocks will be executed in CI. We could tweak this more, but right now the biggest problem with doc iteration time in CI isn't the docs build, it's needing to wait for the pytorch build. - there is a 30 second timeout per md file. We want to emphasize that notebook execution should not be abused for long-running things. Test Plan: - I switched over torch.cond's documentation to markdown. - The new torch.cond doc has some executable code blocks. They are not all executable. - The rendering might look goofy, but I'm confident that everything will render correctly with the pydata-sphinx-theme, so I don't want to spend time trying to figure out the CSS right now.
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/148105
Note: Links to docs will display an error until the docs builds have been completed. ❌ 4 New FailuresAs of commit 903dcab with merge base 7ae0e0b ( NEW FAILURES - The following jobs have failed:
This comment was automatically generated by Dr. CI and updates every 15 minutes. |
This PR needs a
|
|
Looks like this PR hasn't been updated in a while so we're going to go ahead and mark this as |
myst_nb is a plugin that:
Execution of code blocks in markdown docs may slow down build time. In order to limit the impact:
Test Plan: