Jupyter Sphinx 扩展使用教程

Jupyter Sphinx 扩展使用教程

jupyter-sphinxSphinx extension for rendering of Jupyter interactive widgets.项目地址:https://gitcode.com/gh_mirrors/ju/jupyter-sphinx

项目介绍

Jupyter Sphinx 是一个 Sphinx 扩展，它能够在 Sphinx 文档中运行嵌入的代码，并将代码的输出嵌入到生成的文档中。该扩展支持丰富的输出格式，如图像、LaTeX 数学公式，甚至是 Jupyter 交互式小部件。此外，它还允许通过 Thebelab 实现代码的实时执行。

项目快速启动

安装

你可以通过 pip 或 conda 安装 Jupyter Sphinx 扩展：

pip install jupyter_sphinx

或

conda install jupyter_sphinx -c conda-forge

使用

在 Sphinx 项目的 conf.py 文件中添加 jupyter_sphinx 到扩展列表：

extensions = [
    'jupyter_sphinx',
]

在 reStructuredText 文档中嵌入代码：

.. jupyter-execute::

    print("Hello world")

应用案例和最佳实践

嵌入图像和交互式小部件

Jupyter Sphinx 支持嵌入图像和交互式小部件，使得文档更加生动和互动。例如，你可以嵌入一个 Matplotlib 图表：

.. jupyter-execute::

    import matplotlib.pyplot as plt
    plt.plot([1, 2, 3], [4, 5, 6])
    plt.show()

使用 Thebelab 实现实时代码执行

通过 Thebelab，你可以在文档中实现实时代码执行。首先，确保在 conf.py 中配置 Thebelab：

thebelab_config = {
    "bootstrap": True,
}

然后在文档中使用 jupyter-execute 指令：

.. jupyter-execute::

    print("This code can be executed live!")

典型生态项目

Jupyter Notebook

Jupyter Notebook 是一个开源的 Web 应用程序，允许你创建和共享包含实时代码、方程、可视化和叙述性文本的文档。它是数据科学、机器学习和科学计算领域的重要工具。

Sphinx

Sphinx 是一个用于生成智能且美观文档的工具，最初是为 Python 文档而创建的，但它支持多种编程语言。Sphinx 使用 reStructuredText 作为标记语言，并提供了许多扩展来增强文档的功能。

Read the Docs

Read the Docs 是一个文档托管平台，支持自动构建、版本控制和多语言文档。它与 Sphinx 集成良好，可以轻松托管和分享你的项目文档。

通过结合这些工具和平台，你可以创建一个强大且易于维护的技术文档系统。

jupyter-sphinxSphinx extension for rendering of Jupyter interactive widgets.项目地址:https://gitcode.com/gh_mirrors/ju/jupyter-sphinx