Skip to content

Embed example notebooks in docs#64

Merged
darothen merged 4 commits into
mainfrom
docs/embed-example-notebooks
Aug 5, 2025
Merged

Embed example notebooks in docs#64
darothen merged 4 commits into
mainfrom
docs/embed-example-notebooks

Conversation

@darothen
Copy link
Copy Markdown
Contributor

@darothen darothen commented Aug 5, 2025

/title

@darothen darothen requested a review from Copilot August 5, 2025 21:34
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread docs/faq.md
Comment thread docs/faq.md
@darothen darothen merged commit 7d4115d into main Aug 5, 2025
4 checks passed
@darothen darothen deleted the docs/embed-example-notebooks branch August 5, 2025 22:29
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.

2 participants