# What changed in rich-rst

> 16 changes in rich-rst 2 from its official release notes, upgrade guides and advisories: 3 breaking, 1 security, 2 new APIs and options. Each one cited. Sources checked 2026-10-21. HTML: https://unstale.sh/pypi/rich-rst/

To see which of these apply to a repository, run `npx @unstale/cli init` in it.

## rich-rst 2

### Breaking changes

- File-reading directives are disabled by default; pass allow_file_access=True or the CLI flag to enable them for trusted markup. (2.2.0) — [release notes](https://github.com/wasi-master/rich-rst/releases/tag/v2.2.0)
- include and literalinclude resolve symlinks before checking that paths stay inside the source document's directory. (2.2.0) — [release notes](https://github.com/wasi-master/rich-rst/releases/tag/v2.2.0)
- Absolute and ../ paths are no longer accepted, preventing arbitrary local file reads. (2.2.0) — [release notes](https://github.com/wasi-master/rich-rst/releases/tag/v2.2.0)

### Security

- 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. (2.2.0) — [release notes](https://github.com/wasi-master/rich-rst/releases/tag/v2.2.0)

### New APIs and options

- The parsed-literal directive is supported and keeps inline markup inside the literal block. (2.2.0) — [release notes](https://github.com/wasi-master/rich-rst/releases/tag/v2.2.0)
- Sidebar subtitles are supported through :subtitle:. (2.2.0) — [release notes](https://github.com/wasi-master/rich-rst/releases/tag/v2.2.0)

### Behavior and default changes

- Docinfo tables have a title, author lists render as lists, and inline markup in field values is preserved. (2.2.0) — [release notes](https://github.com/wasi-master/rich-rst/releases/tag/v2.2.0)
- A math block's :label: appears in the panel title. (2.2.0) — [release notes](https://github.com/wasi-master/rich-rst/releases/tag/v2.2.0)
- Python domain attribute, property, and data entries show their :type: and :value: in the title. (2.2.0) — [release notes](https://github.com/wasi-master/rich-rst/releases/tag/v2.2.0)

### Fixes and other changes

- Admonitions with background colors now fill the panel body, and their content no longer inherits the panel's style. (2.2.0) — [release notes](https://github.com/wasi-master/rich-rst/releases/tag/v2.2.0)
- The :class: option is no longer ignored by epigraph, highlights, and pull-quote. (2.2.0) — [release notes](https://github.com/wasi-master/rich-rst/releases/tag/v2.2.0)
- Headers and footers preserve inline markup and support |page| substitutions. (2.2.0) — [release notes](https://github.com/wasi-master/rich-rst/releases/tag/v2.2.0)
- Man pages are no longer generated in the wrong section. (2.2.0) — [release notes](https://github.com/wasi-master/rich-rst/releases/tag/v2.2.0)
- Extra blank lines at the end of admonitions and other panels are fixed. (2.2.0) — [release notes](https://github.com/wasi-master/rich-rst/releases/tag/v2.2.0)
- Details of Python domain objects render as a plain list instead of a table. (2.2.0) — [release notes](https://github.com/wasi-master/rich-rst/releases/tag/v2.2.0)
- Extra blank lines at the end of table-of-contents lists are fixed. (2.2.0) — [release notes](https://github.com/wasi-master/rich-rst/releases/tag/v2.2.0)