Example Jupyter Notebook¶

MkDocs supports rendering Jupyter notebooks (.ipynb) as documentation pages using the mkdocs-jupyter plugin. This example notebook demonstrates how notebooks are rendered in this documentation.

Note: By default, notebooks are not executed during the MkDocs build — they are rendered as static HTML. This is because executing notebooks would require all of the notebook's dependencies to be installed in the build environment. Make sure your notebooks have saved cell outputs before adding them to the documentation.

If you need notebooks to be executed at build time, you can enable this by setting execute: true in the mkdocs-jupyter plugin configuration in mkdocs.yml, and ensuring all required dependencies are available in your build environment (e.g., in conda.yaml).

Learn More¶

• mkdocs-jupyter plugin documentation
• MkDocs plugins guide

Python Basics Example¶

Below is a simple Python code cell that computes a sum.

Working with Data¶

A quick example using a list comprehension.

Summary¶

This notebook confirms that .ipynb files render correctly in the MkDocs build.