[X] I have searched the existing issues for similar feature requests.
[X] I added a descriptive title and summary to this issue.
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.)
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.
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.)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