Skip to main content

Embed Stlite frame into Sphinx documentation.

Overview

This is Sphinx extension to provide directive to render Streamlit application on document using Stlite.

When you use this, your document will display interactive contents.

Example

This is example to display table from pandas DataFrame.

.. stlite::

   import streamlit as st
   import pandas as pd

   df = pd.DataFrame({
       'first column': [1, 2, 3, 4],
       'second column': [10, 20, 30, 40]
   })

   st.write(df)

If you want to know how does it display, go to demo page of document.

You can also set external python file.

.. stlite:: example.py

Usage

  1. Install from PyPI (e.g. pip install atsphinx-stlite )

  2. Add atsphinx.stlite to extensions in conf.py of your document.

  3. Write contents refer to documents.

  4. Build your document using HTML-based builders (e.g. make html )

  5. Show it!

For contributing

Do you have a feedback to this?

When you want to contribute to this project, please follow the atsphinx’s common contributing guide.

License

This project is licensed under the Apache License 2.0. See it.

Download files

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

Source Distribution

atsphinx_stlite-0.3.0.tar.gz (87.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

atsphinx_stlite-0.3.0-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

Details for the file atsphinx_stlite-0.3.0.tar.gz.

File metadata

  • Download URL: atsphinx_stlite-0.3.0.tar.gz
  • Upload date:
  • Size: 87.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for atsphinx_stlite-0.3.0.tar.gz
Algorithm Hash digest
SHA256 fbcc83c36c6f76ad2c8432b204dd5aa4525f05a5fb3de1a51ae7cceb1ca3a06f
MD5 dc138544b27bfba64e1372baec3c6a37
BLAKE2b-256 2356c97a6119fb0c461bbdce4efdd55bfbca189a277c909c245970d1e38e7d51

See more details on using hashes here.

Provenance

The following attestation bundles were made for atsphinx_stlite-0.3.0.tar.gz:

Publisher: release.yaml on atsphinx/stlite

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file atsphinx_stlite-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for atsphinx_stlite-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8e63b8eceaabe65023c4c6ae787e8a6fdad1f1aaa607d2c8283d507a05782dc4
MD5 6b88ec20abf89051a0b0e288b4ef6cb4
BLAKE2b-256 bc2758b940fbbe896a60f19ab026152c5f2842a08ba9bfba12f7767ee777ddcb

See more details on using hashes here.

Provenance

The following attestation bundles were made for atsphinx_stlite-0.3.0-py3-none-any.whl:

Publisher: release.yaml on atsphinx/stlite

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.3.0 This release

2 files

0.2.1

2 files

0.2.0

2 files

0.1.0

2 files

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