Udemy
    •  
    •  
    •  
    •  
    •  
    •  
    •  
    •  
Turn what you know into an opportunity and reach millions around the world.
Learn More
Your cart is empty.
Keep shopping
reStructuredText Guide
Rating: 4.1 out of 5(3 ratings)
9 students

reStructuredText Guide

Learn the markup language behind Sphinx, the poweful documentation generator
Created byCarlos Ramos
Last updated 4/2025
English

What you'll learn

  • Learn the basic reStructuredText syntax to create simple documents.
  • Avoid common errors while crafting reStructuredText writings.
  • Understand the effective use of whitespace on reStructuredText.
  • Write confidently using reStructuredText.

Course content

4 sections20 lectures53m total length
  • Introduction1:47
  • Online Resources0:58

Requirements

  • Internet access to use an online editor

Description

reStructuredText Guide is the only course you'll need to understand the basics of the reStructuredText markup language, your first step into crafting beautiful documentation.


In this course you'll learn about the basic syntax of reStructuredText (or reST), from how to use boldface, italics, or monospace font, to creating unordered, ordered, and nested lists, and far into the advanced topics like creating tables and using directives.


You'll learn step by step, with bite-sized lessons that you can use as reference later on (for instance, if you forget the syntax for creating a link).


By the end of the course, you will be able to read and write reST documents fluently.


Course Features


All the syntax elements in the course are demonstrated in an online editor available at my personal domain, site that you can use for free to test the language by yourself!


Online Editor Limitations


While the online editor has the advantage of zero setup and configuration time for you, there are some limitations to what can be done in an online editor. When limitations are hit, they will be mentioned in the lesson, and a sample from the online book will be used instead to demonstrate the offline capabilities.


Who this course is for:

  • Software Developers, as reStructuredText is part of Sphinx, a documentation generation tool.
  • Technical writers, as Sphinx provides all tools needed to document projects beyond software.
  • Writers in general, as reStructuredText can be used to generate PDFs or quick notes.