User guide¶

Installation¶

This is published on PyPI. You can install this by your using package managers.

pip

pip install atsphinx-stlite

uv

uv add atsphinx-stlite

Usage¶

1. Register as extension¶

Append this into extensions of your conf.py:

extensions = [
    # Using other extensions
    ...,
    # Append it.
    "atsphinx.stlite",
]

2. Write Stlite contents¶

Write your Stlite app code into document using stlite directive.

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

3. Build as HTML¶

When you build by HTML-based builder, there are applications of Stlite on your documents.

Please see “Show table from pandas DataFrame” to know build result.

Directives¶

There is stlite directive to write Stlite app code into document.

.. stlite:: source-file¶

Streamlit application block.

You must use either action to set application code.

Set Python code file path relative from document into argument.
Write Python script into content block.

:config:¶

Configuration values for Streamlit.

This supports JSON or TOML format.

:requirements:¶

List of third-party project names required to run application.

This supports multiline strings, comma-separated strings, or combinations.

Configuration¶

There are some configuration values for this extension.

stlite_default_version¶

Type: str

Default: “latest”

Using version of Stlite from CDN.

If you want to lock version of Stlite, set this value.