Skip to main content

Modify valid rst text to fit within given width

Project description

Installation

>>> sudo pip install reflowrst

Usage

Example:

>>> from reflowrst import reflow
>>> text = 'Here is a paragraph that is far too long and will need to wrap.'
>>> print(reflow(text, 47))
Here is a paragraph that is far too long and
will need to wrap.

You can also get the longest possible form of the rst text by using 0 for the space. For example:

>>> paragraph = '''Here is a paragraph that is far too long and
will need to wrap.'''
>>> print(reflow(paragraph, 0))
Here is a paragraph that is far too long and will need to wrap.

Todo

  • ☑ Titles

  • ☑ Transitions

  • ☑ Paragraphs

  • ☑ Bullet Lists

  • ☑ Enumerated Lists

  • ☑ Definitions

  • ☑ Fields

  • ☑ Options

  • ☑ Literal Blocks

  • ☐ Quoted Literal Blocks

  • ☑ Line Blocks

  • ☑ Block Quotes

  • ☐ Doctest Blocks

  • ☑ Grid Tables

  • ☑ Simple Tables

  • ☑ Footnotes

  • ☑ Citations

  • ☑ Directives

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

reflowrst-1.1.0.tar.gz (46.2 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page