Skip to main content

sphinxcontrib-playground ci

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

Quickstart

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)

Directive options

.. playground:: directive options:

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

Souce code of this extension (Demo): https://ydcjeff.github.io/sphinxcontrib-playground/

License

MIT

Metadata

Release files for sphinxcontrib-playground 0.1.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for sphinxcontrib-playground 0.1.4
File Interpreter ABI Platform Actions
sphinxcontrib_playground-0.1.4-py3-none-any.whl Python 3 none any Details for sphinxcontrib_playground-0.1.4-py3-none-any.whl

Release files / sphinxcontrib_playground-0.1.4-py3-none-any.whl

Download URL sphinxcontrib_playground-0.1.4-py3-none-any.whl
Size 4.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
193c0e828551ca5666c58e76236aec91c814fa410dc23f8dc14892550e0dc823
BLAKE2b-256 checksum
How to use checksums
eb365b535d4a175d5904b422f338b5655de41e1c28db78c53fe9d353ddeab8d7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.7.10

Security for sphinxcontrib-playground 0.1.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page