Skip to content

[Docs] Generate searchable tutorial rst pages#820

Draft
ehennestad wants to merge 10 commits into
mainfrom
tutorial-rst-export
Draft

[Docs] Generate searchable tutorial rst pages#820
ehennestad wants to merge 10 commits into
mainfrom
tutorial-rst-export

Conversation

@ehennestad

@ehennestad ehennestad commented Apr 19, 2026

Copy link
Copy Markdown
Collaborator

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?

matnwb_exportTutorials('RunLivescript', false, 'IgnoreFiles', string.empty, 'ExportFormat', '.html')

Todo

  • Confirm current way of saving images/figures works with git, i.e re-export does not create git diffs
  • Confirm images are displayed at reasonable sizes
  • Confirm all tutorials look good

Checklist

  • Have you ensured the PR description clearly describes the problem and solutions?
  • Have you checked to ensure that there aren't other open or previously closed Pull Requests for the same change?
  • If this PR fixes an issue, is the first line of the PR description fix #XX where XX is the issue number?

🤖 Generated with Codex

@ehennestad ehennestad changed the title [codex] Generate searchable tutorial rst pages [Docs] Generate searchable tutorial rst pages Apr 19, 2026
@ehennestad ehennestad added the topic: docs related to documentation label May 31, 2026
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
@ehennestad ehennestad force-pushed the tutorial-rst-export branch from b75622c to 6ace963 Compare June 18, 2026 08:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

topic: docs related to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant