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.

.. 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.