rstformat
A formatter for reStructuredText files.
An open source and free formatter for reStructuredText (.rst) files, distributed under the MIT License.
Features
| Feature | Setting |
|---|---|
| Trim trailing whitespace | trim_trailing_whitespace |
| Output line ending (LF / CRLF / auto-detect) | line_ending |
| Resize section adornments to title width | normalize_section_underlines |
| Add/remove blank lines around headings | normalize_section_spacing |
| Limit consecutive blank lines | max_consecutive_blank_lines |
| Insert final newline | insert_final_newline |
| East-Asian double-width character support | (implicit) |
Plugin system for delegating embedded code-block formatting to language-specific tools:
- Python code blocks → Black or Ruff formatter
- Shell script blocks → shfmt formatter
- SQL blocks → sqlfluff formatter (planned)
Installation
Install from PyPI:
pip install rstformat
Or with uv:
uv tool install rstformat
To enable optional features:
pip install rstformat[editorconfig] # Honor .editorconfig settings
pip install rstformat[lint] # Pre-flight validation via docutils/rstcheck
pip install rstformat[dev] # Development dependencies (tests, ruff)
Usage
Format files in-place:
rstformat file.rst dir/
Check mode (exit 1 if any file would change):
rstformat --check file.rst
Show unified diff without writing:
rstformat --diff file.rst
Read from stdin, write to stdout:
echo "Title\n=====" | rstformat
Control output line endings:
rstformat --line-ending crlf file.rst # Force Windows (CRLF)
rstformat --line-ending auto file.rst # Preserve input style
For all options, run:
rstformat --help
Configuration
Create pyproject.toml or .rstfmt.toml in your project:
[tool.rstformat]
adornments = "#*=-^\"'`:.~_+"
insert_final_newline = true
line_ending = "lf" # "lf" | "crlf" | "auto"
max_consecutive_blank_lines = 2
normalize_section_spacing = true
normalize_section_underlines = true
trim_trailing_whitespace = true
rstformat also respects .editorconfig for compatible settings:
[*.rst]
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
For more details, see DESIGN.md.
Documentation
- Design & Architecture — formatting algorithm, extension API, roadmap
- Changelog — version history
- Security Policy — supported versions, reporting vulnerabilities
- Development Notes — for contributors and AI agents
License
Copyright (c) 2026 LeXtudio Inc.
Licensed under the MIT License. See LICENSE for details.
Community
- GitHub Issues: Report bugs or request features
- GitHub Discussions: Ask questions
- Sponsor: Support development
Metadata
Release files for rstformat 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| rstformat-0.1.0.tar.gz | 50.2 kB | Without provenance | Details for rstformat-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| rstformat-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for rstformat-0.1.0-py3-none-any.whl |
Total release size: 60.5 kB
Release files / rstformat-0.1.0.tar.gz
| Download URL | rstformat-0.1.0.tar.gz |
|---|---|
| Size | 50.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3ea351cdc32c0a9b758e7ac5c6797e8aab690cac2f208c2f91b587a80fdd625c
|
|
BLAKE2b-256 checksum How to use checksums |
cb3dafab4ac0f292b1c43bc87fb26e5ad11a1eb654f3945c506b5c81f8fe889a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.9.5
|
Release files / rstformat-0.1.0-py3-none-any.whl
| Download URL | rstformat-0.1.0-py3-none-any.whl |
|---|---|
| Size | 10.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
dc9681529bcd4caeffff36393088f97895a85018fe9586a8265b64b1fa311455
|
|
BLAKE2b-256 checksum How to use checksums |
8dc73752296639c05e7402c7bbb2bc8e0fdedad56444bd3e3d24918b07d1d979
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.9.5
|
Security for rstformat 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.