Skip to content

A plugin for mkdocs to help you include Jupyter notebooks in your projects

License

Notifications You must be signed in to change notification settings

jc-harrison/mknotebooks

 
 

Repository files navigation

mknotebooks

mknotebooks is a plugin for MkDocs, which makes it more convenient to include Jupyter notebooks in your project documentation.

Install

pip install mknotebooks

Usage

Simply include any notebooks you want to use in the docs source directory, and add mknotebooks to the plugin section of your mkdocs.yml.

You can optionally execute the notebooks, by setting execute: true in the config, and include a hidden preamble script, to be run before executing any cells using preamble: "<path/to/your/script>". The default cell execution timeout can be overridden by setting timeout: <timeout>, where <timeout> is an integer number of seconds.

Any static images, plots, etc. will be extracted from the notebook and placed alongside the output HTML.

Example

An example docs project demonstrating the above is included. Try it out by running pipenv install && pipenv run mkdocs serve.

About

A plugin for mkdocs to help you include Jupyter notebooks in your projects

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%