Helper tools for writing Documentation¶
Tools and Plugins which will help to write documentation.
ReText is a handy editor for .rst and .md formats. On Ubuntu and Debian-based systems all you have to do is
apt-get install retext
Pandoc If you have existing documentation, you may want to check out pandoc , the "swiss army knife" of document conversions. For instance, it can create valid rst files from Markdown and quite a number of other formats. On Ubuntu you can install it via apt
apt-get install pandoc
There is also a online version.
Sublime Text has a number of plugins for rst highlighting and snippets, install via the Sublime package installer.
One particular which is really good for getting a impression how it will looks like in html is OmniMarkupPreviewer a live previewer/exporter for markup files (markdown, rst, creole, textile...).
Emacs has a nice rst-mode. This mode comes
with some Emacs distros. Try
M-x rst-mode in your Emacs and enjoy syntax
coloration, underlining a heading with
Another nice tool for Emacs is Flycheck.
Eclipse users can install ReST Editor through the Eclipse Marketplace.
Vim does syntax highlighting for RST files. There is also a nice plugin with enhanced functionalities called Riv.
restview ReStructuredText viewer A viewer for ReStructuredText documents that renders them on the fly.
pip install restview
These tools can help you to check for grammatical mistakes and typos, you should always use a spell checker anyway!