reStructuredText Supplement

12-Jan-2025 17:10 V.Wheeler - Added Advantages Over Markdown

26-Nov-2024 13:14 V.Wheeler - Added Quick Notes section.

13-Sep-2024 04:01 V.Wheeler - Added “Hyperlinks in a Nutshell”

04-Sep-2024 09:27 V.Wheeler - Created

Contents:

• 1. Abbreviation
• 2. Comparison with Markdown
  • 2.1. Advantages
  • 2.2. Disadvantages
• 3. Silly Things
• 4. Sections
  • 4.1. Pattern Used by WGA Doc/Authoring Projects
  • 4.2. Pattern Used by LVGL Documentation
  • 4.3. How Typora Exports to reStructuredText
  • 4.4. Patterns Rejected for WGA Projects
• 5. Example Headings
  • 5.1. Heading Level 2
    • 5.1.1. Heading Level 3
      • 5.1.1.1. Heading Level 4
        • 5.1.1.1.1. Heading Level 5
          • 5.1.1.1.1.1. Heading Level 6
• 6. Markup
• 7. Implicit Markup
  • 7.1. Plain Definition Lists
  • 7.2. Field Lists
  • 7.3. Option Lists
• 8. Explicit Markup
  • 8.1. Comments
  • 8.2. Directives
  • 8.3. Sidebars
  • 8.4. Glossaries
  • 8.5. Footnotes
    • 8.5.1. More Footnote Syntax
  • 8.6. Citations
  • 8.7. Figure References
  • 8.8. Further Reading
• 9. Hyperlinks
  • 9.1. reST Hyperlinks
    • 9.1.1. Anchor Nomenclature
    • 9.1.2. Reference Names
    • 9.1.3. —> Hyperlink Targets
      • 9.1.3.1. Explicit Internal Hyperlink Targets
      • 9.1.3.2. Implicit Internal Link Targets
      • 9.1.3.3. Explicit External Link Targets
        • 9.1.3.3.1. Link Block Syntax
      • 9.1.3.4. Inline Link Targets
      • 9.1.3.5. Indirect Link Taregets
    • 9.1.4. Hyperlink References —>
      • 9.1.4.1. Standalone Hyperlinks
      • 9.1.4.2. Linking to Explicit Internal Link Targets
      • 9.1.4.3. Embedded Link References
      • 9.1.4.4. Linking to Section Titles
        • 9.1.4.4.1. Within the Same Document
        • 9.1.4.4.2. Linking to List Items
        • 9.1.4.4.3. Linking From Another Web Page
      • 9.1.4.5. Linking to Footnotes and Citations
      • 9.1.4.6. Embedded URIs and Aliases
  • 9.2. Sphinx Hyperlinks
    • 9.2.1. The Problem
    • 9.2.2. The Solution
    • 9.2.3. How it Works
      • 9.2.3.1. When “link text” should be a title or section heading from the target document:
      • 9.2.3.2. When “link text” should be something else:
  • 9.3. Sphinx Hyperlink Policy (for WGA Crystal Research, Inc.)
• 10. Sphinx Code Blocks
• 11. Literal Text
  • 11.1. In-Line Literal Text
    • 11.1.1. Decorated In-Line Literal Text
    • 11.1.2. Interpreted Role Literal Text
    • 11.1.3. Default Interpreted Role
  • 11.2. Literal Blocks
    • 11.2.1. Indented Literal Blocks
    • 11.2.2. Quoted Literal Blocks
    • 11.2.3. Text Code Blocks
    • 11.2.4. Doctest Blocks
  • 11.3. Block Quotes
• 12. Parsing
  • 12.1. Definition Lists
    • 12.1.1. Furo Theme
• 13. Custom Roles and Substitutions
  • 13.1. Creating Custom Roles
    • 13.1.1. Custom Buttons
    • 13.1.2. Keyboard Keys
    • 13.1.3. Simple Outlining
    • 13.1.4. CSS Color Names
  • 13.2. Substitutions
  • 13.3. Unicode Substitutions
• 14. Domains

Indices and tables

• Index

• Module Index

• Search Page