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
8. ReST Hyperlinks
8.1. Anchor Nomenclature
8.2. Reference Names
8.3. —> Hyperlink Targets
8.3.1. Explicit Internal Hyperlink Targets
8.3.2. Implicit Internal Link Targets
8.3.3. Explicit External Link Targets
8.3.3.1. Link Block Syntax
8.3.4. Inline Link Targets
8.3.5. Indirect Link Taregets
8.4. Hyperlink References —>
8.4.1. Standalone Hyperlinks
8.4.2. Linking to Explicit Internal Link Targets
8.4.3. Embedded Link References
8.4.4. Linking to Section Titles
8.4.4.1. Within the Same Document
8.4.4.2. Linking to List Items
8.4.4.3. Linking From Another Web Page
8.4.5. Linking to Footnotes and Citations
8.4.6. Embedded URIs and Aliases
9. Sphinx Hyperlinks
9.1. The Problem
9.2. The Solution
9.3. How it Works
9.3.1. When “link text” should be a title or section heading from the target document:
9.3.2. When “link text” should be something else:
10. Sphinx Hyperlink Policy (for WGA Crystal Research, Inc.)
11. Sphinx Code Blocks
reStructuredText Supplement
1.
Abbreviation
View page source
Previous
Next
1.
Abbreviation
In the below, here and there for brevity, I use “ReST” to stand for “reStructuredText”.