sphinx扩展将sage单元嵌入到网页中
sphinx-sagecell-ext的Python项目详细描述
目录
Installation
Install the sphinx-sagecell-ext from PyPI
$ sudo pip install sphinx-sagecell-ext
Install the sphinx-sagecell-ext from GitHub
$ sudo pip install git+git://github.com/korniichuk/sphinx-sagecell-ext#egg=sphinx-sagecell-ext
Upgrade the sphinx-sagecell-ext from PyPI
$ sudo pip install -U sphinx-sagecell-ext
或:
$ sudo pip install --upgrade sphinx-sagecell-ext
Uninstall the sphinx-sagecell-ext
$ sudo pip uninstall sphinx-sagecell-ext
Development installation
$ git clone git://github.com/korniichuk/sphinx-sagecell-ext.git $ cd sphinx-sagecell-ext $ sudo pip install .
Quickstart
第一个,将sphinx-sagecell-ext.sagecell扩展名添加到conf.py文档文件::
extensions = [ 'sphinx-sagecell-ext.sagecell' ]
second,将layout.htmlfile复制到_templatesdocumentation目录:
$ 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
Options
键/值对用作所创建sage单元实例的配置。嵌入时可以设置以下选项:
Linked cells
当给定多个输入位置时,这将设置来自这些单元的代码是否要从同一内核执行,以便在一个单元中执行的代码将影响来自另一个单元的代码的执行:
.. sagecellserver:: :linked: true .. sagecellserver:: :linked: false
注意
默认情况下,此选项为true。
用于更改默认值。首先,打开/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
Example
.. sagecellserver:: :linked: true x = "first cell" .. sagecellserver:: :linked: false x = "second cell" .. sagecellserver:: :linked: true x