{ "info": { "author": "Jonathan Gray", "author_email": "jonathan.gray@nanosheep.net", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "Natural Language :: English", "Operating System :: MacOS :: MacOS X", "Operating System :: POSIX", "Operating System :: POSIX :: Linux", "Programming Language :: Python :: 3.6" ], "description": "# mknotebooks\n\nmknotebooks is a plugin for [MkDocs](https://mkdocs.org), which makes it more convenient to include [Jupyter](https://jupyter.org) notebooks in your project documentation.\n\n## Install\n\n`pip install mknotebooks`\n\n## Usage\n\nSimply include any notebooks you want to use in the docs source directory, and add mknotebooks to the plugin section of your `mkdocs.yml`.\n\nYou 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: \"\"`. The default cell execution timeout can be overridden by setting `timeout: `, where `` is an integer number of seconds.\n\nAny static images, plots, etc. will be extracted from the notebook and placed alongside the output HTML.\n\n## Example\n\nAn [example docs project](examples/execute_with_preamble) demonstrating the above is included. Try it out by running `pipenv install && pipenv run mkdocs serve`.\n\n## Inspecting generated markdown\n\nYou 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.\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/greenape/mknotebooks", "keywords": "mkdocs documentation markdown", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "mknotebooks", "package_url": "https://pypi.org/project/mknotebooks/", "platform": "MacOS X", "project_url": "https://pypi.org/project/mknotebooks/", "project_urls": { "Homepage": "https://github.com/greenape/mknotebooks" }, "release_url": "https://pypi.org/project/mknotebooks/0.1.7/", "requires_dist": [ "nbconvert", "nbconvert-utils", "mkdocs", "jupyter-client" ], "requires_python": "", "summary": "Plugin for mkdocs to generate markdown documents from jupyter notebooks.", "version": "0.1.7" }, "last_serial": 5873284, "releases": { "0.1.2": [ { "comment_text": "", "digests": { "md5": "ff4b29a1bd3b2bc2aba490fe1bcdaf5a", "sha256": "900dd90816e909092ed8464a5a10e1255bd49fd8b20dc347934c4015cfde03f7" }, "downloads": -1, "filename": "mknotebooks-0.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "ff4b29a1bd3b2bc2aba490fe1bcdaf5a", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 3408, "upload_time": "2018-09-18T08:47:08", "url": "https://files.pythonhosted.org/packages/dd/14/f801a90fb4da7852cd69745de06bdcc5725a5ccd3c6eb85e6ec712f783ab/mknotebooks-0.1.2-py3-none-any.whl" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "61eafa598a694a73eba6a185ad71191e", "sha256": "183cd430cbcb730521391eef3477db7e1808b56b2ebb4ed32b45be561cbd63a9" }, "downloads": -1, "filename": "mknotebooks-0.1.3-py3-none-any.whl", "has_sig": false, "md5_digest": "61eafa598a694a73eba6a185ad71191e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 3414, "upload_time": "2018-09-18T09:03:03", "url": "https://files.pythonhosted.org/packages/5f/79/255ef76e399c33b7606a7c6043261d24dc68a9c855b9ed053c5bd43e2562/mknotebooks-0.1.3-py3-none-any.whl" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "004a39a64b26f938297e56dd8db09b3d", "sha256": "0718282aa96112e9f18e1a67e49c9cb8e86ddc128a4e3de922f88816b777ac66" }, "downloads": -1, "filename": "mknotebooks-0.1.4-py3-none-any.whl", "has_sig": false, "md5_digest": "004a39a64b26f938297e56dd8db09b3d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 3413, "upload_time": "2018-09-18T09:12:34", "url": "https://files.pythonhosted.org/packages/f6/aa/bd2867157f6faa64cc59e2b25901d56f58f404d49789b3c786800895aeae/mknotebooks-0.1.4-py3-none-any.whl" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "c2538a852b11282f617ab9e226a8e636", "sha256": "c2becd398457316f5713734ec369eca30369c9772e50662206e3fb9b4ff07728" }, "downloads": -1, "filename": "mknotebooks-0.1.5-py3-none-any.whl", "has_sig": false, "md5_digest": "c2538a852b11282f617ab9e226a8e636", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 3848, "upload_time": "2018-09-18T09:17:00", "url": "https://files.pythonhosted.org/packages/8e/13/53e695295267e5159b87c1ec8aee93154c45da64b47f1d73d702b537aae4/mknotebooks-0.1.5-py3-none-any.whl" } ], "0.1.6": [ { "comment_text": "", "digests": { "md5": "117b1d9e5f313f765729e85e61deb5da", "sha256": "584f1ce2641955db7ac622526a4eb0997a5acf5c2d1b733be1bdf70d7ea5a5bb" }, "downloads": -1, "filename": "mknotebooks-0.1.6-py3-none-any.whl", "has_sig": false, "md5_digest": "117b1d9e5f313f765729e85e61deb5da", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4758, "upload_time": "2019-03-27T10:50:14", "url": "https://files.pythonhosted.org/packages/e6/97/e21f94b7e85ed630f0c6f8a0b8c0faa052d23762e0dcd5cd156d60d53e15/mknotebooks-0.1.6-py3-none-any.whl" } ], "0.1.7": [ { "comment_text": "", "digests": { "md5": "b0acf8c324a5b4e924b5ce7b9f9e2420", "sha256": "4481d90657c184395bb53607dfb56a6b0720017807b56b8e5e775eb6c9639b8a" }, "downloads": -1, "filename": "mknotebooks-0.1.7-py3-none-any.whl", "has_sig": false, "md5_digest": "b0acf8c324a5b4e924b5ce7b9f9e2420", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4880, "upload_time": "2019-09-23T12:16:53", "url": "https://files.pythonhosted.org/packages/78/aa/d6027d34d3876523b74e574bac2345536b41018594d44b47fed9e47772cf/mknotebooks-0.1.7-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "b0acf8c324a5b4e924b5ce7b9f9e2420", "sha256": "4481d90657c184395bb53607dfb56a6b0720017807b56b8e5e775eb6c9639b8a" }, "downloads": -1, "filename": "mknotebooks-0.1.7-py3-none-any.whl", "has_sig": false, "md5_digest": "b0acf8c324a5b4e924b5ce7b9f9e2420", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4880, "upload_time": "2019-09-23T12:16:53", "url": "https://files.pythonhosted.org/packages/78/aa/d6027d34d3876523b74e574bac2345536b41018594d44b47fed9e47772cf/mknotebooks-0.1.7-py3-none-any.whl" } ] }