1.3. RestructedText & Sphinx Syntax

Important

Anytime you change indention level in a rst document, there needs to be a blank line between changes. (Except with the options for directives)

• 1.3.1. Headings
• 1.3.2. Sphinx Roles
  • 1.3.2.1. Inline Text Markup Roles
  • 1.3.2.2. List Roles
  • 1.3.2.3. Specialized Roles
• 1.3.3. Sphinx Directives
  • 1.3.3.1. Image & Figure Directives
  • 1.3.3.2. Note Block Directives
  • 1.3.3.3. Tables Directives
  • 1.3.3.4. Code or Literal Directives
  • 1.3.3.5. Specialized Directives
  • 1.3.3.6. Latex Directives
  • 1.3.3.7. Custom Directives (Not part of Sphinx baseline)
  • 1.3.3.8. Sphinx Diagram Directives (BlockDiag)
    • 1.3.3.8.1. blockdiag Directive - Block Diagram
    • 1.3.3.8.2. blockdiag Directive - Activity Diagram
    • 1.3.3.8.3. blockdiag Directive - Sequence Diagram
    • 1.3.3.8.4. blockdiag Directive - Network Diagram
    • 1.3.3.8.5. blockdiag Directive - Packet Diagram
    • 1.3.3.8.6. blockdiag Directive - Rack Diagram
  • 1.3.3.9. Sphinx Diagram Directives (PlantUML)
  • 1.3.3.10. Image & Figure Directives
  • 1.3.3.11. Sphinx Diagram Directives (Mermaid Diagrams)
• 1.3.4. Linking