Sphinx Markup Constructs¶

Sphinx adds a lot of new directives and interpreted text roles to standard reST markup. This section contains the reference material for these facilities.

• Module-specific markup
• Object description units
  • Signatures
  • Info field lists
  • Command-line program markup
  • Custom description units
• Paragraph-level markup
• Table-of-contents markup
• Index-generating markup
• Glossary
• Grammar production displays
• Showing code examples
  • Line numbers
  • Includes
• Inline markup
  • Cross-referencing syntax
  • Cross-referencing Python objects
  • Cross-referencing C constructs
  • Cross-referencing other items of interest
  • Cross-referencing arbitrary locations
  • Cross-referencing documents
  • Referencing downloadable files
  • Other semantic markup
  • Substitutions
• Miscellaneous markup
  • File-wide metadata
  • Meta-information markup
  • Including content based on tags
  • Tables