SPHINX

Navigation

  • Documentation »
  • Using Sphinx »
  • reStructuredText

Quick search

On this page

  • reStructuredText

Site navigation

Get started

  • Getting Started
  • Installing Sphinx
  • Build your first project

User Guides

  • Using Sphinx
    • reStructuredText
      • reStructuredText Primer
      • Roles
      • Directives
      • Field Lists
      • Domains
    • Markdown
    • Configuration
    • Builders
    • Extensions
    • HTML Theming
    • Internationalization
    • Setuptools integration
    • Sphinx Web Support
  • Extending Sphinx
  • Templating
  • LaTeX customization
  • Developing extensions for Sphinx

Community

  • Get support
  • Contribute to Sphinx
  • Sphinx FAQ

Reference

  • Command-Line Tools
  • Glossary
  • Changelog
  • Projects using Sphinx

reStructuredTextΒΆ

reStructuredText (reST) is the default plaintext markup language used by both Docutils and Sphinx. Docutils provides the basic reStructuredText syntax, while Sphinx extends this to support additional functionality.

The below guides go through the most important aspects of reST. For the authoritative reStructuredText reference, refer to the docutils documentation.

  • reStructuredText Primer
    • Paragraphs
    • Inline markup
    • Lists and Quote-like blocks
    • Literal blocks
    • Doctest blocks
    • Tables
    • Hyperlinks
    • Sections
    • Field Lists
    • Roles
    • Explicit Markup
    • Directives
    • Images
    • Footnotes
    • Citations
    • Substitutions
    • Comments
    • HTML Metadata
    • Source encoding
    • Gotchas
  • Roles
    • Cross-referencing syntax
    • Inline code highlighting
    • Math
    • Other semantic markup
    • Substitutions
  • Directives
    • Table of contents
    • Paragraph-level markup
    • Showing code examples
    • Glossary
    • Meta-information markup
    • Index-generating markup
    • Including content based on tags
    • Tables
    • Math
    • Grammar production displays
  • Field Lists
    • File-wide metadata
    • Special metadata fields
  • Domains
    • Basic Markup
    • The Python Domain
    • The C Domain
    • The C++ Domain
    • The Standard Domain
    • The JavaScript Domain
    • The reStructuredText domain
    • The Math Domain
    • More domains
© Copyright 2007-2022, the Sphinx developers. Created using Sphinx 5.1.1.