reStructuredText Supplement

Contents:

  • 1. Abbreviation
  • 2. Comparison with Markdown
    • 2.1. Advantages
    • 2.2. Disadvantages
  • 3. Explicit Directive Quick Notes
    • 3.1. Comments
    • 3.2. QuickNote: Explicit Directive
    • 3.3. QuickNote: Explicit Internal Hyperlink Targets
    • 3.4. QuickNote: Explicit External Hyperlink Targets
    • 3.5. Footnotes
    • 3.6. Citations
    • 3.7. Substitutions
  • 4. Silly Things
  • 5. Markup
  • 6. Sections
    • 6.1. Pattern Used by LVGL Documentation
    • 6.2. Pattern Used by WGA Projects
    • 6.3. How Typora Exports to reStructuredText
    • 6.4. Patterns Rejected for WGA Projects
  • 7. Hyperlinks in General
    • 7.1. ReST Hyperlinks
      • 7.1.1. Anchor Nomenclature
      • 7.1.2. Reference Names
      • 7.1.3. —> Hyperlink Targets
        • 7.1.3.1. Explicit Internal Hyperlink Targets
        • 7.1.3.2. Implicit Internal Link Targets
        • 7.1.3.3. Explicit External Link Targets
        • 7.1.3.4. Inline Link Targets
        • 7.1.3.5. Indirect Link Taregets
      • 7.1.4. Hyperlink References —>
        • 7.1.4.1. Standalone Hyperlinks
        • 7.1.4.2. Linking to Explicit Internal Link Targets
        • 7.1.4.3. Embedded Link References
        • 7.1.4.4. Linking to Section Titles
        • 7.1.4.5. Linking to Footnotes and Citations
        • 7.1.4.6. Embedded URIs and Aliases
    • 7.2. Sphinx Hyperlinks
      • 7.2.1. The Problem
      • 7.2.2. The Solution
      • 7.2.3. How it Works
        • 7.2.3.1. When “link text” should be a title or section heading from the target document:
        • 7.2.3.2. When “link text” should be something else:
    • 7.3. Sphinx Hyperlink Policy (for WGA Crystal Research, Inc.)
  • 8. Sphinx Code Blocks
reStructuredText Supplement
  • Search

© Copyright 2024, Victor Wheeler.

Built with Sphinx using a theme provided by Read the Docs.