https://github.com/korniichuk/sphinx-sagecell-ext
The Sphinx extension embedding a Sage cell into a webpage
https://github.com/korniichuk/sphinx-sagecell-ext
Last synced: 6 months ago
JSON representation
The Sphinx extension embedding a Sage cell into a webpage
- Host: GitHub
- URL: https://github.com/korniichuk/sphinx-sagecell-ext
- Owner: korniichuk
- License: unlicense
- Created: 2015-10-20T06:12:33.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-02-26T00:39:54.000Z (over 9 years ago)
- Last Synced: 2025-04-19T20:10:55.300Z (6 months ago)
- Language: Python
- Size: 85 KB
- Stars: 2
- Watchers: 2
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE.txt
Awesome Lists containing this project
README
.. contents:: Table of contents
:depth: 3
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::
$ url1=https://raw.githubusercontent.com/
$ url2=korniichuk/sphinx-sagecell-ext/master/layout.html
$ wget -P DEST $url1$url2
Where:
* ``DEST`` -- a path to ``_templates`` documentation directory.
Example::
$ url1=https://raw.githubusercontent.com/korniichuk/
$ url2=sphinx-sagecell-ext/master/layout.html
$ wget -P ~/sphinx-sagecell-ext/source/_templates $url1$url2
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
.. image:: ./img/options-_linked_cells_0001_728px.png
:alt: options: linked_cells [prtscn]