rich-rst 1.1.2

A beautiful reStructuredText renderer for rich

rich-rst

Allows rich to print a reStructuredText document in a rich format similar to rich.Markdown.

Features

75 supported reStructuredText elements. For a list see ELEMENTS.md

Command line interface

Show the contents of readme.rst

python -m rich_rst readme.rst

Get from stdin

python -m rich_rst -

For more help see python -m rich_rst --help

Usage

Note: There are some aliases: RST, ReStructuredText, reStructuredText, RestructuredText

from rich_rst import RestructuredText
from rich import print

print(RestructuredText("This is a **test** document"))

Advanced usage

from rich_rst import RestructuredText
from rich import print

# Documentation for discord.py: https://pypi.org/project/discord.py
docs = "discord.py\n==========\n\n.. image:: https://discord.com/api/guilds/336642139381301249/embed.png\n   :target: https://discord.gg/r3sSKJJ\n   :alt: Discord server invite\n.. image:: https://img.shields.io/pypi/v/discord.py.svg\n   :target: https://pypi.python.org/pypi/discord.py\n   :alt: PyPI version info\n.. image:: https://img.shields.io/pypi/pyversions/discord.py.svg\n   :target: https://pypi.python.org/pypi/discord.py\n   :alt: PyPI supported Python versions\n\nA modern, easy to use, feature-rich, and async ready API wrapper for Discord written in Python.\n\nKey Features\n-------------\n\n- Modern Pythonic API using ``async`` and ``await``.\n- Proper rate limit handling.\n- 100% coverage of the supported Discord API.\n- Optimised in both speed and memory.\n\nInstalling\n----------\n\n**Python 3.5.3 or higher is required**\n\nTo install the library without full voice support, you can just run the following command:\n\n.. code:: sh\n\n    # Linux/macOS\n    python3 -m pip install -U discord.py\n\n    # Windows\n    py -3 -m pip install -U discord.py\n\nOtherwise to get voice support you should run the following command:\n\n.. code:: sh\n\n    # Linux/macOS\n    python3 -m pip install -U \"discord.py[voice]\"\n\n    # Windows\n    py -3 -m pip install -U discord.py[voice]\n\n\nTo install the development version, do the following:\n\n.. code:: sh\n\n    $ git clone https://github.com/Rapptz/discord.py\n    $ cd discord.py\n    $ python3 -m pip install -U .[voice]\n\n\nOptional Packages\n~~~~~~~~~~~~~~~~~~\n\n* PyNaCl (for voice support)\n\nPlease note that on Linux installing voice you must install the following packages via your favourite package manager (e.g. ``apt``, ``dnf``, etc) before running the above commands:\n\n* libffi-dev (or ``libffi-devel`` on some systems)\n* python-dev (e.g. ``python3.6-dev`` for Python 3.6)\n\nQuick Example\n--------------\n\n.. code:: py\n\n    import discord\n\n    class MyClient(discord.Client):\n        async def on_ready(self):\n            print('Logged on as', self.user)\n\n        async def on_message(self, message):\n            # don't respond to ourselves\n            if message.author == self.user:\n                return\n\n            if message.content == 'ping':\n                await message.channel.send('pong')\n\n    client = MyClient()\n    client.run('token')\n\nBot Example\n~~~~~~~~~~~~~\n\n.. code:: py\n\n    import discord\n    from discord.ext import commands\n\n    bot = commands.Bot(command_prefix='>')\n\n    @bot.command()\n    async def ping(ctx):\n        await ctx.send('pong')\n\n    bot.run('token')\n\nYou can find more examples in the examples directory.\n\nLinks\n------\n\n- `Documentation <https://discordpy.readthedocs.io/en/latest/index.html>`_\n- `Official Discord Server <https://discord.gg/r3sSKJJ>`_\n- `Discord API <https://discord.gg/discord-api>`_\n\n\n"

print(RestructuredText(docs, code_theme="dracula", show_errors=False))

Changelog

[0.1.0]

• Initial Release

[0.2.0]

• Added a command line interface

[0.2.1], [0.2.2]

• Small documentation fixes

[0.2.3]

• Fixed a bug with images without alt not being shown

[0.2.5]

• Add code_theme parameter support for code blocks

[1.0.0]

• Add support for most of the elements possible

[1.0.1]

• Add support for the rubric element
• Fix a but where the error message wasn't parsed properly and therefore the parser crashed
• Fix system messages showing up twice
• Fix math blocks not having new lines

[1.1.0]

New Features

• Add support for acronym

• Add support for attribution

• Add support for citations and citation references

• Add support for decoration

• Add support for footers

• Add support for headers

• Add support for footnotes

• Add support for more elements in definition lists and improve formatting

• Add subscript and superscript support for some letters and symbols

• Add support for pending

• Add support for raw

• Add custom default lexer support

• Add support for guessing the lexer

CLI

• Add code theme argument
• Add support for html output

Docs

• Add demos to the demos folder
• Specify that caption is not possible
• Specify that figures are not supported

Bugs

• Fix a bug where newlines weren't replaced with spaces as they should be
• Also get lexer name from format for literal codeblocks

[1.1.1]

• Fix default lexer not being used sometimes
• Improve formatting for html with raw tag
• Add hide-error option for the CLI

[1.1.2]

• Admonitions are now shown inside panels
• Fields are now shown inside tables