用于mkdocs从jupyter笔记本生成标记文档的插件。

mknotebooks的Python项目详细描述


mk笔记本

mknotebooks是一个用于MkDocs的插件,这使得在项目文档中包含Jupyter笔记本更加方便。

安装

pip install mknotebooks

用法

只需在docs源目录中包含任何要使用的笔记本,并将mknotebooks添加到mkdocs.yml的插件部分。

您可以选择在使用preamble: "<path/to/your/script>"执行任何单元格之前,通过在配置中设置execute: true来执行笔记本,并包括一个隐藏的前导脚本。可以通过设置timeout: <timeout>覆盖默认单元格执行超时,其中<timeout>是整数秒数。

任何静态图像、绘图等都将从笔记本中提取出来,并放在输出HTML旁边。

示例

还包括演示上述内容的example docs project。通过运行pipenv install && pipenv run mkdocs serve来尝试它。

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java集合属性值   java字符串==运算符是否比较引用?   java是否存在过太多的ListView或适配器?   json获取java中类路径中下载的文件   我可以用java代码解决数据库并发问题吗?   在多个线程中使用forEach()或使用forEach()和lambdas进行java集合迭代   java输出JFrame中的整个循环   java禁用高度详细的日志记录   java在没有特定属性的对象中访问模型的值   java Smack xmpp建立连接   处理过时域对象引起的并发问题的java策略(Grails/GORM/Hibernate)   java从ObservableList中提取元素   使用图像进行java相似图像搜索   java ListView和图像:我快疯了   在Java中,如何从毫秒时间戳中提取一天的周期?   java我需要这样的设计,但我面临两个问题   java如何获取JGoodies FormLayout中的单元格大小   Spring引导生成的java War文件未部署到Weblogic 12c