用于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如何在sqlite数据库中保存特定列的历史记录   java如何更改/更新timeseriechart名称(JFreeChart)   java如何将整数转换为可绘制的   汇编什么解释Java的字节码   java查找已编译的类版本号   我应该什么时候在ColdFusion应用程序中使用Java?   java当一个实体的两个字段为(unique=true)时,如何处理JPA异常?   java为什么在所有其他实例都正确的情况下返回错误的布尔值?   java Hibernate每次都准备语句   java停留在平均字长上   对Java和日语字符进行编码   java如何将导致异常的方法的错误消息传递给侦听器中的onTestFailure方法   java代码没有打印结果   java为什么私有内部接口的方法必须是公共的?   休眠发生错误。有关详细信息,请参阅错误日志。JAVAlang.NullPointerException