Skip to content

Conversation

@mvdoc
Copy link
Collaborator

@mvdoc mvdoc commented Mar 7, 2025

This PR adds a major refactoring of the rendered tutorials. They are now rendered with jupyter-book, improving the reading flow.

For maintenance, notebooks are edited and added directly in the notebooks folder as ipynb files. We don't need to write scripts and convert them to notebooks anymore. This reduces the number of moving parts and should make it easier to maintain the tutorials.

Tasks

  • Set up jupyter-book
  • Add references
  • Convert rst to markdown
  • Fix scripts to use bibtex references
  • Fix Makefile to convert scripts and build book in one go
  • Figure out better file structure
  • Update logo
  • Check warnings in rendered notebooks
  • Check if I can render the progress bar better

@mvdoc mvdoc changed the title ENH Convert rendered tutorials to jupyter-book ENH Use jupyter-book for the rendered website Mar 7, 2025
@mvdoc mvdoc linked an issue Mar 10, 2025 that may be closed by this pull request
@mvdoc mvdoc changed the title ENH Use jupyter-book for the rendered website REF,ENH Use jupyter-book for the rendered website Mar 10, 2025
@mvdoc mvdoc merged commit aaba874 into gallantlab:main Mar 10, 2025
@mvdoc mvdoc deleted the enh/jupyter-book branch March 10, 2025 14:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remove vim2 tutorial since it's redundant with the shortclips tutorial

1 participant