Metadata-Version: 2.4
Name: atsphinx-stlite
Version: 0.2.1
Summary: Embed Stlite frame into Sphinx documentation.
Project-URL: Home, https://github.com/atsphinx/stlite
Project-URL: Documentation, https://atsphinx.github.io/stlite
Author-email: Kazuya Takei <myself@attakei.net>
License-Expression: Apache-2.0
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Text Processing
Classifier: Topic :: Text Processing :: Markup
Classifier: Topic :: Text Processing :: Markup :: reStructuredText
Requires-Python: >=3.10
Requires-Dist: jinja2>=3.1.6
Requires-Dist: sphinx
Requires-Dist: tomli>=2.3.0; python_full_version < '3.11'
Description-Content-Type: text/x-rst

===============
atsphinx-stlite
===============

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.

.. code:: rst

   .. 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 <https://atsphinx.github.io/stlite/en/examples/pandas-dataframe/>`_.

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 <https://atsphinx.github.io/stlite/en/>`_.
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 <https://atsphinx.github.io/en/contributing/>`_.

License
=======

This project is licensed under the Apache License 2.0.
See `it <https://github.com/atsphinx/stlite/blob/main/LICENSE>`_.
