Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
My Project 1.0.0 documentation
My Project 1.0.0 documentation
  • 1. Sphinx Manual
    • 1.1. Sphinx Documentation Structure
    • 1.2. Building a Table of Contents
    • 1.3. RestructedText & Sphinx Syntax
      • 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
    • 1.4. Getting Started with Sphinx from template
  • 1. ACRONYM LIST
Back to top
View this page

1.3.2. Sphinx RolesΒΆ

Note

All :roles: below need the a string immediately following role in backticks ie :command:`Punch`

  • 1.3.2.1. Inline Text Markup Roles
  • 1.3.2.2. List Roles
  • 1.3.2.3. Specialized Roles
Next
1.3.2.1. Inline Text Markup Roles
Previous
1.3.1. Headings
Copyright © 2026, Galaxy Forest Labs
Made with Sphinx and @pradyunsg's Furo