Pink RST 🩷

Opinionated ReStructured Text (.rst) Formatter inspired by Black.

Remember: RST Files wear pink EVERY day of the week.

Works well with doc8

There's only one file, so read it if you want the docs.

Install

pip3 install pinkrst

or

pip install pinkrst

Usage

pink file.rst # to process individual file

pink --max-line-length 100 file.rst # set max line length

pink # to process files in dir and recursively processes sub-folder files

pink --no-recurse # to process files in dir WITHOUT recusion

# to process files recursively in dir WITHOUT ensuring there's a trailing newline at the end of files
pink --disable-trailing-newline 

 # or go crazy, see next section
pink --no-recurse --disable-replace-tabs --spaces-per-tab 4 --disable-smart-wrap --max-line-length 100 directory/

CLI Arguments