Rst Tools [2021] May 2026
The connection between RST (Rhetorical Structure Theory) and storytelling revolves around using structured logic to create coherent and engaging narratives. While RST was originally developed to analyze the relationships between parts of a text, modern tools have adapted it to build better stories and automated narrative systems. RST in Storytelling
Rhetorical Structure Theory is used in narrative design to ensure that every "segment" of a story serves a purpose. Researchers have even developed a Storytelling Ontology Model (SRST) based on RST relations to map out how different plot points connect logically. This helps in:
Narrative Coherence: Ensuring the flow between events makes sense to the reader.
Data-Driven Stories: In node-based editors, RST tools allow authors to organize narratives around the relationships between data segments rather than just linear time.
Dynamic Structures: Developing narrative structures that avoid the "trappings of traditional narratives" by using a dynamic, tree-like logic. Key RST Tools for Analysis and Writing
If you are looking to work with RST for text analysis or documentation (often in .rst format), several tools are widely used: apluslms/a-plus-rst-tools - GitHub
Provides tools to publish RST course content for mooc-grader and a-plus. A-plus RST tools comprise a set of Sphinx extensions. GitHub a-plus-rst-tools/README.md at master - GitHub
Provides tools to publish RST course content for mooc-grader and a-plus. ... A-plus RST tools comprise a set of Sphinx extensions. GitHub
This guide explores the essential tools and frameworks for both, helping you choose the right ecosystem for your project. 1. reStructuredText (reST) Documentation Tools
reStructuredText is a more formalized and powerful alternative to Markdown, frequently used in the Python ecosystem for technical documentation. Its strength lies in its extensibility and ability to handle complex cross-referencing and indexing. Core Frameworks & Generators
Sphinx: The industry standard for reST documentation. It converts .rst files into HTML websites, PDFs (via LaTeX), ePubs, and more. It is used by major projects like Django and the official Python documentation. rst tools
Docutils: The reference implementation and parser for reStructuredText. It provides the fundamental tools for converting reST into other formats like HTML or XML.
Pelican: A static site generator that natively supports reStructuredText, making it a popular choice for developers building technical blogs. Editors with reST Support
Visual Studio Code: Supports reST through the reStructuredText extension from LeXtudio, providing live previews and syntax highlighting.
PyCharm / JetBrains IDEs: Features the "reStructuredText Pro" plugin, offering synchronized live previews and automatic table formatting.
Zed: A high-performance editor that uses Tree-sitter for precise syntax highlighting and real-time updates even in large files.
ReText: A dedicated, cross-platform editor written in Python specifically designed for writing Markdown and reStructuredText with live previews. Converters & Utilities Sphinx — Sphinx documentation
(reStructuredText tools) refer to a suite of software used to write, preview, and publish documentation using the reStructuredText
markup language. These tools are widely utilized in the Python community and large-scale open-source projects like the Linux kernel. Core RST Ecosystem
The ecosystem is built around a few foundational tools that handle the parsing and conversion of plain-text files into formats like HTML, PDF, or LaTeX.
: The core system that provides the standard parser and writer for reStructuredText. The connection between RST (Rhetorical Structure Theory) and
: The most popular documentation generator that extends Docutils to handle multi-file projects, cross-references, and indexing.
: A "universal document converter" often used to transform RST files into other formats like Markdown or Word. Popular Writing and Editing Tools
RST is plain text, so you can use any editor, but specialized tools offer syntax highlighting and live previews. Write the Docs apluslms/a-plus-rst-tools - GitHub
The primary tools for working with reStructuredText (reST or rst) center on the Docutils Python package
, which serves as the core parser and compiler for the language. While reST was designed to be highly readable as plain text, a robust ecosystem of tools—most notably
—transforms these simple files into professional documentation in formats like HTML, PDF, and LaTeX. Core Documentation Engines
: The industry standard for Python documentation, Sphinx builds upon Docutils to handle complex, multi-file projects. It offers features like automatic indexing, cross-referencing, and a pluggable interface for extensions.
: The base library that provides several command-line "front-ends." For instance,
allow for quick conversion of single files without the setup overhead of a full Sphinx project.
: A specialized tool that uses ReportLab to bypass the need for a LaTeX installation when generating PDF documents, making it an efficient choice for creating slide decks and manuals. Advanced Utilities and Extensions a-plus-rst-tools/README.md at master - GitHub Sphinx Extensions That Feel Like Separate RST Tools
Provides tools to publish RST course content for mooc-grader and a-plus. ... A-plus RST tools comprise a set of Sphinx extensions.
a-plus-rst-tools/directives/questionnaire.py at master - GitHub
Use saved searches to filter your results more quickly * Issues 44. * Pull requests 1. * Uh oh! a-plus-rst-tools/aplus_setup.py at master - GitHub
Sphinx Extensions That Feel Like Separate RST Tools
sphinx.ext.graphviz– Write.. graphviz::blocks to generate diagrams from DOT language.sphinxcontrib.mermaid– Embed Mermaid.js flowcharts and sequence diagrams in RST.sphinx.ext.todo– Manage.. todo::notes that can be hidden in production builds.sphinxcontrib.plantuml– For UML diagrams in your docs.
1. Docutils – The Foundation of All RST Tools
Before Sphinx, there was Docutils (Documentation Utilities). It is the reference implementation of ReStructuredText. Every other RST tool builds on top of it.
Key features:
- Core
rst2html.py,rst2pdf.py,rst2latex.pyconverters. - Standard directive and role system.
- Command-line interface for quick conversions.
When to use: When you need a lightweight, zero-configuration converter for a single RST file. For large projects, you’ll graduate to Sphinx, but Docutils is irreplaceable for scripts and one-offs.
# Convert a single file
rst2html.py mydoc.rst mydoc.html
3. The Style Enforcer: rstcheck
While doc8 checks the general "sanity" of the file, rstcheck is a syntax checker. Think of it as a spellchecker for your RST grammar.
RST syntax can be subtle. For example, if you have a heading underline that is shorter than the heading text, the build will fail. rstcheck catches these specific structural errors instantly.
- Why it’s essential: It catches syntax errors that
doc8might miss, particularly regarding malformed tables or invalid directive options.
8. When to Choose RST Tools (vs. Markdown)
| Scenario | Recommended Toolchain | |----------|----------------------| | Python library documentation | Sphinx + autodoc + Read the Docs | | Scientific paper with equations | Sphinx + rst2latex + BibTeX | | Multi-volume technical manual | Sphinx + intersphinx + toctree | | GitHub README only | Markdown (avoid RST) | | Blog or casual writing | Markdown | | Legacy RST migration | pandoc + manual cleanup |