Rich reStructuredText Renderer

1.3.2 · active · verified Sat Mar 28

A Python library that provides a beautiful reStructuredText renderer, integrating with the `rich` library to display reStructuredText documents with syntax highlighting and rich formatting directly in the terminal. It's currently at version 1.3.2 and maintains an active release cadence with regular updates and bug fixes.

Warnings

gotcha Compatibility with `docutils` versions can be sensitive. `rich-rst` is regularly updated to track `docutils` changes (e.g., v1.3.2 updated for Docutils 0.22). Ensure your `docutils` version is compatible to avoid rendering issues.
Fix: Upgrade `rich-rst` to the latest version (`pip install --upgrade rich-rst`) to ensure compatibility with recent `docutils` versions.
gotcha Older versions of `rich-rst` (pre-1.3.0) might have exposed `docutils`' internal `optparse` deprecation warnings. While fixed in newer releases, this indicates potential for upstream dependency deprecations impacting users.
Fix: Upgrade to `rich-rst` version 1.3.0 or newer to mitigate `optparse` deprecation warnings from `docutils`.
gotcha While `rich-rst` supports many reStructuredText elements and common Sphinx roles (since v1.3.2), highly complex or obscure directives/roles might not render perfectly in the terminal environment as they would in Sphinx-generated HTML documentation. Test complex documents thoroughly.
Fix: Simplify complex reStructuredText structures if rendering fidelity in the terminal is critical, or be prepared for minor visual discrepancies in highly advanced documents.

Install

pip install rich-rst Install latest version

Imports

RestructuredText
```
from rich_rst import RestructuredText
```
print
```
from rich import print
```
Used for displaying rich content to the console.

Quickstart

This quickstart demonstrates how to import `RestructuredText` from `rich_rst` and use it with `rich.print` to render a reStructuredText string directly to your terminal with rich formatting.

from rich_rst import RestructuredText
from rich import print

rst_content = """
My Document
===========

This is a *simple* reStructuredText document.

.. code:: python

    print('Hello, Rich RST!')

- Item 1
- Item 2

.. note:: This is a note.
"""

# Render the reStructuredText to the console
print(RestructuredText(rst_content))

view raw JSON →