A Quick Primer on reStructuredText

When it comes to writing software documentation, software developers generally prefer to use a lightweight markup language over binary formats such as DOCX or other word processor files. Such languages aim to provide a standardized way of notating basic rich-text features like bullet lists, emphasized text, section headings, tables, and inline code within the limits of a plaintext file, while remaining human-readable. Documents written in lightweight markup languages can be read as-is, or compiled into other formats like PDF, DOCX, or HTML.

This approach has several advantages over the use of binary word processor files:

• The documentation can be treated like code: it can be edited with the code editor and easily managed with tools like a Version Control System (VCS).
• The documentation has universal access: it can be read from any system with a text editor, or even from a terminal prompt.
• The writing process is less distracting...