pypi / rich-rst
rich-rst
What changed in rich-rst 2, from its official release notes, upgrade guides and advisories. Sources checked 2026-10-21.
3 breaking1 security2 new APIs and options3 behavior and defaults7 fixes and other
See which of these apply to your code, ranked, in your agent:
npx @unstale/cli initrich-rst 216 changes
Breaking changes 3
File-reading directives are disabled by default; pass allow_file_access=True or the CLI flag to enable them for trusted markup.
include and literalinclude resolve symlinks before checking that paths stay inside the source document's directory.
Absolute and ../ paths are no longer accepted, preventing arbitrary local file reads.
Security 1
The fix prevents arbitrary local file reads through raw directives using :file: or :url:; it also covers csv-table and docutils include when sphinx_compat=False.
New APIs and options 2
The parsed-literal directive is supported and keeps inline markup inside the literal block.
Sidebar subtitles are supported through :subtitle:.
Behavior and default changes 3
Docinfo tables have a title, author lists render as lists, and inline markup in field values is preserved.
A math block's :label: appears in the panel title.
Python domain attribute, property, and data entries show their :type: and :value: in the title.
Fixes and other changes 7
Admonitions with background colors now fill the panel body, and their content no longer inherits the panel's style.
The :class: option is no longer ignored by epigraph, highlights, and pull-quote.
Headers and footers preserve inline markup and support |page| substitutions.
Man pages are no longer generated in the wrong section.
Extra blank lines at the end of admonitions and other panels are fixed.
Details of Python domain objects render as a plain list instead of a table.
Extra blank lines at the end of table-of-contents lists are fixed.