rst-previewer
A modern CLI tool that finds reStructuredText (.rst) files in a directory and displays them in a clean, web-based Gradio interface. Perfect for quickly previewing documentation, articles, or notes without a full Sphinx build.
Installation
This tool is designed to be installed and run in an isolated environment using pipx. This avoids cluttering your global Python installation.
Install rst-previewer:
pipx install rst-previewer
That's it! The rst-previewer command is now available anywhere in your terminal.
Usage
Select a file from a directory:
rst-previewer /path/to/your/project/docs/
The tool will print a local URL to your terminal. Open this URL in your web browser to see the rendered document.
Development Guide
Interested in contributing? Setting up a development environment is easy.
Prerequisites
- Git
- Python 3.10+
- uv
License
This project is licensed under the MIT License. See the LICENSE file for details.
1 maintainer
Metadata
1 maintainer
Release files for rst-previewer 0.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| rst_previewer-0.1.2.tar.gz | 564.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| rst_previewer-0.1.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 570.9 kB
Release files / rst_previewer-0.1.2.tar.gz
| Download URL | rst_previewer-0.1.2.tar.gz |
|---|---|
| Size | 564.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
928500c0e64ef5eff4908f7cf9ec04991d6cc82ca51f002318afd836f153312c
|
|
BLAKE2b-256 checksum How to use checksums |
c2cddb623379aebaae1a1d1e8e8ef9104b9cd309390a03c74777e2176177ffef
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-httpx/0.28.1
|
Release files / rst_previewer-0.1.2-py3-none-any.whl
| Download URL | rst_previewer-0.1.2-py3-none-any.whl |
|---|---|
| Size | 6.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b25b2bbfd98b6c597af9a6cf2a40b785f333711122934ed7601719de62f0e9f1
|
|
BLAKE2b-256 checksum How to use checksums |
227636b323067c93a2e16a17cc27b90e7795f7f64a968f70169302791c0ea02c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-httpx/0.28.1
|
