Skip to main content

Sphinx sagecellserver extension

Project description

This extension defines a directive 'sagecellserver' which allows to embedd sage cell inside sphinx doc. To learn more about sage cell server visit: http://aleph.sagemath.org/static/about.html

Installation

  1. Install this extension: 'python setup.py install --user'
  2. Move 'layout.html' to your '_templates' directory. Change sagecell paths if necessary
  3. Add 'icsecontrib.sagecellserver' to your extensions in 'conf.py'

How to use it

Example of usage::

.. sagecellserver::

    sage: A = matrix([[1,1],[-1,1]])
    sage: D = [vector([0,0]), vector([1,0])]
    sage: @interact
    sage: def f(A = matrix([[1,1],[-1,1]]), D = '[[0,0],[1,0]]', k=(3..17)):
    ...       print "Det = ", A.det()
    ...       D = matrix(eval(D)).rows()
    ...       def Dn(k):
    ...           ans = []
    ...           for d in Tuples(D, k):
    ...               s = sum(A^n*d[n] for n in range(k))
    ...               ans.append(s)
    ...           return ans
    ...       G = points([v.list() for v in Dn(k)],size=50)
    ...       show(G, frame=True, axes=False)


.. end of output

Options

The sage prompts can be removed by adding setting 'prompt_tag' option to False::

.. sagecellserver::
    :prompt_tag: False

Setting 'prompt_tag' to True has same effect as removing ':prompt_tag:'.

During latex/pdf generation sagecell code can be displayed inside '\begin{verbatim}' and '\end{verbatim}' tags or as a single \textbf 'SAGE CELL' message. This message is a reminder of sage cell exsistence. For example later this text can be manually replaced by screenshoot of sagcell example (mostly @interact example).

This option is controlled using 'is_verbatim' option. Default is 'True'.::

.. sagecellserver::
    :is_verbatim: True

Project details


Download files

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

Source Distribution

icsecontrib-sagecellserver-1.3.tar.gz (2.9 kB view details)

Uploaded Source

Built Distribution

icsecontrib_sagecellserver-1.3-py3-none-any.whl (3.3 kB view details)

Uploaded Python 3

File details

Details for the file icsecontrib-sagecellserver-1.3.tar.gz.

File metadata

  • Download URL: icsecontrib-sagecellserver-1.3.tar.gz
  • Upload date:
  • Size: 2.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.0 setuptools/51.3.3 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.6.9

File hashes

Hashes for icsecontrib-sagecellserver-1.3.tar.gz
Algorithm Hash digest
SHA256 64bd4f7cf2c47cbec05e5c8b2d3fb3df5ed072b9a243e81eb1a3c5c73be226e9
MD5 bd2de5a0bbb64a153f5665d6c53486b7
BLAKE2b-256 40bbb7e42714b933a612005bdff36c711acda3f0b4f6e7c0abd453fbba72a5a3

See more details on using hashes here.

File details

Details for the file icsecontrib_sagecellserver-1.3-py3-none-any.whl.

File metadata

  • Download URL: icsecontrib_sagecellserver-1.3-py3-none-any.whl
  • Upload date:
  • Size: 3.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.0 setuptools/51.3.3 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.6.9

File hashes

Hashes for icsecontrib_sagecellserver-1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 90ec98257c6b28f40d8b1d92aa842584c652fb06096f605433f682eae886fbe2
MD5 c5b0f71ce48e8cb333a895743c875d48
BLAKE2b-256 bd1f9db7a943d30d5da93b9e842827095022d36c333cc9ad911d4dd0f4cc4039

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page