Skip to content
Wagtail Sphinx Wagtail Theme
  • Installation
  • Usage
  • Customizing
  • Development
  • Examples
    • Admonitions
    • Autodoc
    • Code Blocks
    • Headings
    • Inline Styles
    • Images
    • Links
    • Lists
    • Nesting
      • Child
    • Paragraphs
    • Progressive Disclosure
    • Quotes
    • Page in reStructuredText
    • Tables
    • Tables of Content
    • Version Changes
  • Contributing
  • Contributors
  • Changelog
  1. Docs
  2. Examples
  3. Links
Edit on GitHub View source

Links¶

Links are fundamental in documentation. Use internal links to tie your content to other docs, and external links as needed. Pick relevant text for links, so readers know where they will land.

External Links¶

An external link.

Internal Links¶

An internal link to another document.

Reference Links¶

Reference links (links to a target within a page) rely on the page having a reference created, this can be added as follows:

(this_is_the_reference_point)=

The reference can be linked to, with a custom label, using the Markdown link syntax as follows:

A [link to a reference](this_is_the_reference_point).

A link to a reference.

Links Over Code¶

When using inline code as the text for a link it is hard to see.

Unless, we can take special care of that in the styling.

← Images Lists  →

Page contents

  • Links
    • External Links
    • Internal Links
    • Reference Links
    • Links Over Code
  • Features
  • About Wagtail
  • Services
  • Blog
  • Packages
  • Developers
© Copyright 2022, Wagtail contributors
Created using Sphinx Wagtail Theme 6.6.0.dev0 and Sphinx 8.2.0