Skip to main content

将 Sage 单元格嵌入网页的 Sphinx 扩展

项目描述

<nav class="contents" id="table-of-contents" role="doc-toc">

目录

</nav>

安装

从 PyPI 安装 sphinx-sagecell-ext

$ sudo pip install sphinx-sagecell-ext

从 GitHub 安装 sphinx-sagecell-ext

$ sudo pip install git+git://github.com/korniichuk/sphinx-sagecell-ext#egg=sphinx-sagecell-ext

从 PyPI 升级 sphinx-sagecell-ext

$ sudo pip install -U sphinx-sagecell-ext

或者:

$ sudo pip install --upgrade sphinx-sagecell-ext

卸载 sphinx-sagecell-ext

$ sudo pip uninstall sphinx-sagecell-ext

开发安装

$ git clone git://github.com/korniichuk/sphinx-sagecell-ext.git
$ cd sphinx-sagecell-ext
$ sudo pip install .

快速开始

首先,将sphinx-sagecell-ext.sagecell扩展添加到conf.py文档文件:

extensions = [
    'sphinx-sagecell-ext.sagecell'
]

其次,将layout.html文件复制到_templates文档目录:

$ wget -P DEST https://raw.githubusercontent.com/korniichuk/sphinx-sagecell-ext/master/layout.html

在哪里:

  • DEST_templates文档目录的路径。

例子:

$ wget -P ~/sphinx-sagecell-ext/source/_templates https://raw.githubusercontent.com/korniichuk/sphinx-sagecell-ext/master/layout.html

用法

以下是一些示例用法:

.. sagecellserver::

   sphere()

选项

键/值对用作创建的 Sage Cell 实例的配置。嵌入时可以设置以下选项:

链接单元格

当给定多个输入位置时,这将设置来自这些单元的代码是否要从同一个内核执行,以便在一个单元中执行的代码将影响来自另一个单元的代码的执行:

.. sagecellserver::
   :linked: true

.. sagecellserver::
   :linked: false

用于更改默认值。首先,打开/usr/local/lib/python2.7/dist-packages/sphinx-sagecell-ext/sagecell.py文件:

$ sudo gedit /usr/local/lib/python2.7/dist-packages/sphinx-sagecell-ext/sagecell.py

其次,将下一个代码从:

linked = True

至:

linked = False

例子

.. sagecellserver::
   :linked: true

   x = "first cell"

.. sagecellserver::
   :linked: false

   x = "second cell"

.. sagecellserver::
   :linked: true

   x
选项:linked_cells [prtscn]

下载文件

下载适用于您平台的文件。如果您不确定要选择哪个,请了解有关安装包的更多信息。

源分布

sphinx-sagecell-ext-0.1rc4.zip (43.8 kB 查看哈希)

已上传 source

sphinx-sagecell-ext-0.1rc4.tar.gz (41.1 kB 查看哈希)

已上传 source