Megacorp Documentation v2.0-beta

Hyperlinks and Targets

This page demonstrates the various hyperlink and target features now supported by Rinx.

External Targets

You can define explicit external targets using the .. _name: URL syntax. These can be on a single line or indented on the next line.

Now we can link to Google or the Rust Language easily.

Embedded URIs

You can also embed URIs directly within a phrased link using the ` `Text <URL>`_ ` syntax.

Check out the Sphinx Documentation for more details on reStructuredText.

Phrased links use backticks and an underscore: Python Website. Simple links are just a word followed by an underscore: Sphinx.

Ordinary identifiers that merely contain underscores, such as my_variable_name or foo_bar_baz, are left as plain text and are not treated as references, since they don't end in a trailing underscore at a word boundary.

Case Insensitivity and Normalization

Target names are normalized. This means GOOGLE, google, and Google all point to the same target defined above.

Internal References

Of course, standard internal references still work: Rinx Example Site.

Anonymous hyperlinks use a double underscore (__). They are resolved based on their order of appearance.

The first anonymous link points to the first anonymous target: Example 1. The second anonymous link points to the second anonymous target: link2.

You can also use embedded URIs anonymously: Google Search. These do not consume targets from the list above.