Skip to content

[docs] Document pdf_viewer alt in README - #35

Closed
sfc-gh-mbarnes wants to merge 1 commit into
mainfrom
docs/readme-alt-param
Closed

sfc-gh-mbarnes wants to merge 1 commit into
mainfrom
docs/readme-alt-param

Conversation

@sfc-gh-mbarnes

Copy link
Copy Markdown
Contributor

Summary

  • Document streamlit_pdf.pdf_viewer (the package API) including keyword-only alt
  • Add usage / accessible-name examples so the PyPI README matches 2.1.0
  • Keep existing st.pdf examples for the usual streamlit[pdf] install path

Why before release

PyPI renders this README. Tag v2.1.0 should be moved to the merge commit of this PR (or recreated on the new main tip) before running the Release workflow, so 2.1.0 ships with docs.

Test plan

  • Preview README on GitHub
  • After merge: retag v2.1.0 on new main, then run Release from that tag

Made with Cursor

Surface the package API and accessible-name param on PyPI so 2.1.0
release notes match the shipped pdf_viewer signature.

Co-authored-by: Cursor <cursoragent@cursor.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants