sphinxcontrib-playground 0.1.0

A Sphinx extension for embedding interactive demo using The Python Playground

sphinxcontrib-playground

A Sphinx extension to embed interactive demo examples with The Python Playground.

Install with pip:

pip install sphinxcontrib-playground

Include below options in conf.py:

playground_options = {
    'commit_sha': subprocess.check_output(['git', 'rev-parse', 'HEAD'], encoding='utf-8').strip(),
    'github_repo': 'github repo in string'  # e.g. ydcjeff/sphinxcontrib-playground
    'url': 'https://python-playground.netlify.app'  # playground url (you should have your own playground forked from The Python Playground)
}

Use with .. playground:: directive:

.. playground:: path/to/the/python/file.py
      :title: Playground (Mandatory title - helpful for screen readers)

.. playground:: directive options:

• title: Mandatory title for the embedding playground (helpful for screen readers)
• height: Height of the embedding playground (default: 500)
• with: Width of the embedding playground (default: 100%)

Souce code of this extension (Demo):

<iframe src='https://python-playground.netlify.app/?github.com/ydcjeff/sphinxcontrib-playground/blob/main/sphinxcontrib/playground.py' loading='lazy' allow='fullscreen' id='p-embed-sphinx-extension-playground' class='p-embed-iframe' name='p-embed-sphinx-extension-playground' width='100%' height='500' style='border: 1px solid #ddd;' title='A Sphinx extension for The Python Playground' ></iframe>