reStructuredText Guide

Welcome to the reStructuredText Guide in its online version!

Table of Contents

• Introduction
  • How to read this book?
  • Contributing
  • Found a problem?
• First Steps
  • Is it a language or a tool?
  • Online Editor
  • Markdown Comparison
  • reStructuredText and Sphinx
  • Are we programming?
  • Summary
• What can we do with reST?
  • With the online editor
  • With Sphinx
  • Summary
• Basic Syntax
  • Paragraphs and whitespace
  • Quotes and indentation
  • Basic Formatting
  • Headers (Titles)
  • Comments
  • Lists
  • Preformatting (code samples)
  • External Links
  • Internal Links
  • Tables
  • Summary
• Directives
  • Image
  • Figures
  • Code (Embedded)
  • Code (external file)
  • tab-width option
  • Inserting HTML or LaTeX with raw
  • Admonitions
  • Math
  • Extensibility
  • Summary
• Where to now?