[Docs] Generate searchable tutorial rst pages#820
Draft
ehennestad wants to merge 10 commits into
Draft
Conversation
Updated file identifier. Should be globally unique and not confused with session id Used reproducible random number generation to produce predictable files / output
Fix ophys tutorial, removing image processing toolbox dependency
b75622c to
6ace963
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Problem:
The current tutorial pages are not searchable because they are embedded HTML frames.
Solution:
Replace iframe-embedded tutorial pages with generated reStructuredText pages so tutorial content becomes searchable in the Sphinx/Read the Docs docs.
This PR adds a conversion pipeline for exporting .mlx and .m-file tutorials to RST. Tutorial media (images and figures are saved to a docs-specific static location.
How to test the behavior?
Todo
Checklist
fix #XXwhereXXis the issue number?🤖 Generated with Codex