Vimalkumar Velayudhan


reStructuredText for Sphinx

A Beginner’s Guide by Vimalkumar Velayudhan
First edition, 2023.

Get the e-book

From LeanpubGumroadOther book stores

You can also get it as a bundle from Leanpub, which includes 2 books: this book + How to Create and Publish an E-Book Using Sphinx.

About the book

This book will help you learn the basic reStructuredText (reST) syntax used in writing documentation using Sphinx.

Cover of reStructuredText for Sphinx

What you will learn

  • Create a new Sphinx project
  • Learn to write sections, links, images, footnotes, abbreviations, code samples, and more using the reST syntax
  • Live preview your writing (HTML)

Which will help you

  • Write documentation for your projects
  • Contribute to projects using Sphinx
  • Publish a book or a manual
  • Create a static website using Pelican

Get the eBook from



Pages from the eBook open in Calibre

Pages from the eBook open in Calibre. Click to view a larger image.

Table of Contents

  • About this book
  • Getting started with Sphinx
    • a) Installing Sphinx
    • b) Creating a Sphinx project
    • c) Previewing the project
    • d) Updating the project
    • e) Setting up live preview
  • Basic reStructuredText
    • Adding a title
    • Adding sections and paragraphs
    • Adding comments
    • Adding links
    • Adding images
    • Adding horizontal lines
    • Complete example
  • Additional elements
    • Adding abbreviations
    • Adding substitutions
    • Adding footnotes
    • Adding a glossary
    • Adding code samples
    • Complete example
  • Resources
  • Next steps
    • Have an idea for a book?

Last updated: Wed 26 July 2023