Skip to content

Conversation

enryH
Copy link

@enryH enryH commented Sep 12, 2025

I just propose to use myst-nb to execute the notebooks directly and make some updates to the theme. Rather to show how it works.

You can read about the template here, and a see a description here

  • use sphinx_book_theme (light & dark mode available)
  • add notebooks to sidebar
  • execute notebooks on documentation build time
  • Update heading in notebooks
  • Update docstrings and type annotations (there are some warnings)

@enryH
Copy link
Author

enryH commented Sep 12, 2025

Just a preview to showcase the current look

image

@enryH
Copy link
Author

enryH commented Sep 12, 2025

Some of the notebooks need pandas and teemi which you not install as main dependencies. And thecookbook.ipynb fails with: 'Dseqrecord' object has no attribute 'cseguid'

@enryH
Copy link
Author

enryH commented Sep 13, 2025

It runs the build process now in my fork, but there are plenty of warnings to deal with. At the moment I treat warnings as errors, leading the GitHub Action to fails.

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.

1 participant