Metadata-Version: 1.1
Name: sphinx-sagecell-ext
Version: 0.1rc4
Summary: The Sphinx extension embedding a Sage cell into a webpage
Home-page: https://github.com/korniichuk/sphinx-sagecell-ext
Author: Ruslan Korniichuk
Author-email: ruslan.korniichuk@gmail.com
License: Public Domain
Download-URL: https://github.com/korniichuk/sphinx-sagecell-ext/archive/0.1.zip
Description: .. 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::
        
            $ 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
        
        .. image:: ./img/options-_linked_cells_0001_728px.png
          :alt: options: linked_cells [prtscn]
        
Keywords: extension,python2,sagecell,sphinx,sphinx-sagecell-ext
Platform: Linux
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: License :: Public Domain
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 2 :: Only
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Scientific/Engineering
