streamlit / streamlit

Streamlit — A faster way to build and share data apps.
https://streamlit.io
Apache License 2.0
33.18k stars 2.9k forks source link

Make `st.help` render restructured text when passes Streamlit objects #8850

Open sfc-gh-dmatthews opened 3 weeks ago

sfc-gh-dmatthews commented 3 weeks ago

Checklist

Summary

Streamlit docstrings use Numpy standards and restructured test. st.help does not parse all syntax in Streamlit docstrings as intended. (Most prominently, code text in our docstrings uses double backticks, whereas markdown uses single backticks.)

image

Why?

st.help should be able to fully parse Streamlit docstrings and render them in the best way.

How?

Add handling for restructured text. Automatic detection may not be feasible, but special handling for Streamlit docstrings should be possible and worth the bit of polish.

MVP: Handle inline code, links, and text replacements Elaborate: Fully parse restructured directives.

Additional Context

No response

github-actions[bot] commented 3 weeks ago

To help Streamlit prioritize this feature, react with a 👍 (thumbs up emoji) to the initial post.

Your vote helps us identify which enhancements matter most to our users.

Visits