Embed example notebooks in docs#64
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for embedding Jupyter notebooks in the documentation site by integrating the mkdocs-jupyter plugin. The main purpose is to make example notebooks accessible directly within the documentation.
Key changes include:
- Added mkdocs-jupyter plugin dependency and configuration
- Added new "Example Notebooks" section to navigation with 4 notebook entries
- Updated internal documentation links to use relative paths instead of absolute paths
Reviewed Changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Added mkdocs-jupyter dependency for docs build |
| mkdocs.yml | Configured mkdocs-jupyter plugin and added Example Notebooks navigation section |
| docs/faq.md | Updated internal links to use relative paths and reorganized TOC |
| docs/example_notebooks | Created symlink to example_notebooks directory |
| docs/datasets.md | Updated internal links to use relative paths |
| README.md | Updated internal link to use relative path |
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.
/title