Metadata-Version: 2.1
Name: mknotebooks
Version: 0.1.6
Summary: Plugin for mkdocs to generate markdown documents from jupyter notebooks.
Home-page: https://github.com/greenape/mknotebooks
Author: Jonathan Gray
Author-email: jonathan.gray@nanosheep.net
License: MIT
Keywords: mkdocs documentation markdown
Platform: MacOS X
Platform: Linux
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.6
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: Linux
Description-Content-Type: text/markdown
Requires-Dist: nbconvert
Requires-Dist: nbconvert-utils
Requires-Dist: mkdocs
Requires-Dist: jupyter-client

# mknotebooks

mknotebooks is a plugin for [MkDocs](https://mkdocs.org), which makes it more convenient to include [Jupyter](https://jupyter.org) 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](examples/execute_with_preamble) demonstrating the above is included. Try it out by running `pipenv install && pipenv run mkdocs serve`.

