使用Jupyter笔记本中的Sphinx创建示例库
sphinx-nbexamples的Python项目详细描述
| docs | |
|---|---|
| tests | |
| package | |
| implementations |
欢迎类似于Oscar Najerassphinx-gallery模块，这个模块打算 为文档创建示例库但是，我们不使用 相反，我们用一堆jupyter创建示例库 使用nbconvert的笔记本
这个包可以用来
- 把你准备好的所有例子放在不同的笔记本上 图库
- 使用相同的html（sphinx）方案作为示例 您的文档
- 在脱机（pdf）文档中包括示例笔记本
- 不仅包括代码，还包括指向所需补充文件的链接
- 包括指向Jupyter nbviewer 的链接
安装
只需通过pip安装即可：
$ pip install sphinx-nbexamples
或者通过以下方式安装：
$ python setup.py install
从source on GitHub开始。
要求
包需要
- Sphinx>；=1.3:用于生成自动文档的python库
- jupyter：jupyter笔记本电脑的jupyter框架。狮身人面像
明确取决于
- nbconvert：用于将jupyter笔记本转换为RST
- jupyter_client：用于管理内核
- ipykernel：用于安装ipython内核并运行笔记本
欢迎加入QQ群-->： 979659372
