Documatt logo
  • Product
  • Pricing
  • Resources
    • Sphinx Errors
    • reStructuredText
    • Community
  • Blog
  • Login
  • Try free
  • Product
  • Pricing
  • Sphinx Errors
  • reStructuredText
  • Community
  • Blog
Logo of reStructuredText Reference

reStructuredText 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.

Intro

  • reStructuredText overview
  • Directives and roles
  • Sphinx and Docutils
  • Tools and editors

Collections

  • Admonitions
  • Body elements
  • Code examples
  • Images
  • Inline elements
  • Lists
  • Document parts
  • Semantic elements
  • Sphinx additions

Elements

  • admonition
  • attention
  • caution
  • code-block
  • contents
  • danger
  • emphasis
  • enumerated-list
  • error
  • figure
  • file
  • hint
  • image
  • important
  • inline image
  • inline literal
  • literal-block
  • note
  • paragraph
  • parsed-literal-block
  • rubric
  • section
  • seealso
  • sidebar
  • strong emphasis
  • subscript
  • substitution
  • superscript
  • tip
  • toctree
  • topic
  • transition
  • warning

Etc.

  • Contributing
reStructuredText Reference Contents without backlinks

Contents without backlinks#

Testing contents:: directive without backlinks.

Contents

  • Contents without backlinks

    • Section L2

    • Very very very very very very very loooooooooooooong section L2

      • Section L3

      • Very very very very very very very loooooooooooooong section L3

Section L2#

Very very very very very very very loooooooooooooong section L2#

Section L3#

Very very very very very very very loooooooooooooong section L3#

Documatt logo
Effortlessly create books and docs in Markdown and reStructuredText. Perfect for tech and novel writers.
© 2025, Documatt.com, s.r.o. and contributors - All rights reserved.

Product

  • What is Documatt
  • Plans & Pricing
  • Tech writing services

Resources

  • Blog
  • Sphinx Errors
  • reStructuredText

Company

  • About us
  • Legal
  • Contact us

Social