Skip to main content

Plugin for mkdocs to generate markdown documents from jupyter notebooks.

Project description

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.

Inspecting generated markdown

You can also export the generated markdown by setting write_markdown: true in your mkdocs.yml. This will write the generated markdown to a .md.tmp file alongside the original notebook.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mknotebooks, version 0.1.7
Filename, size File type Python version Upload date Hashes
Filename, size mknotebooks-0.1.7-py3-none-any.whl (4.9 kB) File type Wheel Python version py3 Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page