File: execution.rst

package info (click to toggle)
pydata-sphinx-theme 0.16.1%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 6,088 kB
  • sloc: python: 2,796; javascript: 701; makefile: 42; sh: 12
file content (38 lines) | stat: -rw-r--r-- 1,455 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
Execution Libraries
===================

Many execution libraries can be used to display the output of IPyhton cells. We used ``MySTnb`` to parse and display the outputs presented in :doc:`./pydata`. In this section we'll show alternatives that runs code for you using a Jupyter like kernel.

Jupyterlite
-----------

.. warning::
    The jupyterLite lib is not yet providing a handle to switch from light to dark theme. If you consider using it in your documentation you should also enforce the light theme to your users.
    Follow https://github.com/jupyterlite/jupyterlite-sphinx/issues/69 for more information.

``jupyterlite-sphinx`` brings the power of `JupyterLite <https://jupyterlite.readthedocs.io/en/latest/>`__ to your Sphinx documentation. It makes a full JupyterLite deployment in your docs and provide some utilities for using that deployment easily.

This section demonstrate how it displays in a **pydata-sphinx-theme** context:

.. replite::
    :kernel: python
    :height: 600px
    :prompt: Try Replite!

    print("it's a test")

jupyter-sphinx
--------------

Another common library is ``jupyter-sphinx``.
This section demonstrates a subset of functionality to make sure it behaves as expected.

.. jupyter-execute::

    import matplotlib.pyplot as plt
    import numpy as np

    rng = np.random.default_rng()
    data = rng.standard_normal((3, 100))
    fig, ax = plt.subplots()
    ax.scatter(data[0], data[1], c=data[2], s=3)