reStructuredText and Sphinx Reference

Example based gentle reference of the reStructuredText and Sphinx syntax, directives, roles and common issues. It demonstrates almost all the markup making it also good for testing Sphinx themes. Free and open-source.

Follow us

Table of Contents

Intro

Collections

Elements

Etc.

Contributing

Contents without a document title¶

Testing contents:: directive with :local: flag.

Section L2 ¶

Very very very very very very very loooooooooooooong section L2 ¶

Section L3 ¶

Very very very very very very very loooooooooooooong section L3 ¶

On this page

Contents without a document title
- Section L2
- Very very very very very very very loooooooooooooong section L2
  - Section L3
  - Very very very very very very very loooooooooooooong section L3