Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

The Sphinx extension embedding a Sage cell into a webpage

Project description

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

or:

$ 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

First, add sphinx-sagecell-ext.sagecell extension to conf.py documentation file::

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

Second, copy layout.html file to _templates documentation directory:

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

Where:

  • DEST – a path to _templates documentation directory.

Example:

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

Usage

The following is some example usage:

.. sagecellserver::

   sphere()

Options

The key/value pairs serve as the configuration of the created Sage Cell instance. The following options can be set when embedding:

Linked cells

When multiple input locations are given, this sets whether the code from these cells is to be executed from the same kernel, so that code executed in one will affect the execution of code from another cell:

.. sagecellserver::
   :linked: true

.. sagecellserver::
   :linked: false

Note

This option is true by default.

For changing the default value. First, open the /usr/local/lib/python2.7/dist-packages/sphinx-sagecell-ext/sagecell.py file:

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

Second, change the next code from:

linked = True

to:

linked = False

Example

.. sagecellserver::
   :linked: true

   x = "first cell"

.. sagecellserver::
   :linked: false

   x = "second cell"

.. sagecellserver::
   :linked: true

   x
options: linked_cells [prtscn]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinx-sagecell-ext, version 0.1rc4
Filename, size File type Python version Upload date Hashes
Filename, size sphinx-sagecell-ext-0.1rc4.tar.gz (41.1 kB) File type Source Python version None Upload date Hashes View
Filename, size sphinx-sagecell-ext-0.1rc4.zip (43.8 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page