Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
ubCode 0.38.0 documentation
Light Logo Dark Logo

Start here

  • What is ubCode?
  • Installation
  • Quickstart
  • Your first traced project

Choose your path

  • Requirements & traceability
  • Publish HTML & PDF
  • Sphinx & Sphinx-Needs
  • Engineer with AI agents

How-to guides

  • Trace source code
  • Build variants
  • Write reports
  • Run ubc in CI
  • Use another editor
  • Build an HTML site
  • Build a PDF
    • Page classes at work
  • Migrate from Sphinx-Needs

AI agents

  • AI agents, checked by the engine
  • Pharaoh agentic engineer
    • Quick start
    • Configuring the workflow
    • Reviews and quality analysis
    • Recovering intent from code
    • Changing what is already specified
    • The ubc agent command
    • In VS Code
  • MCP server
  • Chat participant

Writing and configuration

  • Writing content
    • reStructuredText basics
      • The basics in MyST
    • reStructuredText tables
      • Tables in MyST
    • References and links
      • References and links in MyST
    • Roles
      • Roles in MyST
    • Markdown (MyST)
      • MyST core syntax
      • MyST extensions
    • Needs
      • Writing needs
        • Writing needs in MyST
      • Need roles
        • Need roles in MyST
      • Need views
        • Need views in MyST
      • Importing and extending needs
        • Importing and extending needs in MyST
      • Dynamic functions and filters
        • Dynamic functions and filters in MyST
    • Variants
      • Variants in MyST
    • Test reports: the directives
      • Test reports in MyST
    • Traced source code
    • Directives
      • Admonitions
        • Admonitions in MyST
      • Code and includes
        • Code and includes in MyST
      • Images, figures and video
        • Images, figures and video in MyST
      • Version markers
        • Version markers in MyST
      • Glossary, index, confval and envvar
        • Glossary, index, confval and envvar in MyST
      • Structure and layout
        • Structure and layout in MyST
      • Conditional content
        • Conditional content in MyST
      • Page state
        • Page state in MyST
      • Math
        • Math in MyST
      • Todos
        • Todos in MyST
      • Directives in MyST
    • Layout components
      • Layout components in MyST
    • Diagrams
      • Diagrams in MyST
    • Unsupported syntax
    • Differences from a Sphinx build
    • Writing content in MyST
  • Configuration
    • Needs
    • Card designs with [needs.card_layouts]
    • Field links with [needs.string_links]
    • Schema validation
    • Derived fields
    • Deprecated needs options
    • Codelinks (source code tracing)
    • Test reports
    • Intersphinx
    • Link checking
    • Parsing
    • Linting
    • Formatting
    • Server
    • Project, source & scripts
    • HTML site
    • PDF document
    • Workflow
    • Quality Analysis

Reference

  • Feature matrix
  • Command line (ubc)
  • Configuration keys
    • [agent]
    • [build.highlight]
    • [build.html]
    • [build.mermaid]
    • [build.pdf]
    • [build.plantuml]
    • [codelinks]
    • [format_rst]
    • [intersphinx]
    • [linkcheck]
    • [lint]
    • [needs]
    • [needs_json]
    • [parse]
    • [project]
    • [quality]
    • [reports]
    • [rst_lint]
    • [scripts]
    • [server]
    • [source]
    • [test_reports]
    • [variants]
    • [workflow]
  • VS Code
  • MCP tools
  • Diagnostic codes
  • VS Code features
    • Home view
    • Linting
    • RST preview
    • Realtime index
    • Needs filtering
    • Needs graph view
    • Navigation
    • Site Map
    • Commands
    • Diff & impact analysis
    • needs.json view
  • Query language
  • Languages
  • Supported toolchain
  • What works in imported needs

Concepts

  • Key concepts
    • Glossary
  • Maturity levels

ubCode for teams

  • ubCode for teams
  • Request a license
  • Troubleshooting
  • Report an issue

Development

  • Roadmap
  • Changelog
    • 0.38.x
    • 0.37.x
    • 0.36.x
    • 0.35.x
    • 0.34.x
    • 0.33.x
    • 0.32.x
    • 0.31.x
    • 0.30.x
    • 0.29.x
    • 0.28.x
    • 0.27.x
    • 0.26.x
    • 0.25.x
    • 0.24.x
    • 0.23.x
    • 0.22.x
    • 0.21.x
    • 0.20.x
    • 0.19.x
    • 0.18.x
    • 0.17.x
    • 0.16.x
    • 0.15.x
    • 0.14.x
    • 0.13.x
    • 0.12.x
    • 0.11.x
    • 0.10.x
    • 0.9.x
    • 0.8.x
    • 0.7.x
    • 0.6.x
    • 0.5.x
    • 0.4.x
    • 0.3.x
    • 0.2.x
Back to top
View this page
Edit this page

References and links in MyST¶

The MyST forms of the specimens on References and links, each rendered live by this page’s own Markdown parser. Their labels carry names of their own, because a label defined twice in one project is reported. Constructs MyST has no spelling of, on this site, have no section here.

Targets and {ref}¶

A target and its references

(ex-references-myst-target)=

This paragraph carries a target.
Link to it {ref}`with your own text <ex-references-myst-target>`
or as a Markdown link, [to the target](#ex-references-myst-target);
link to a section by its title: {ref}`authoring_references_citations`.

This paragraph carries a target. Link to it with your own text or as a Markdown link, to the target; link to a section by its title: Citations.

Hyperlinks¶

Hyperlinks

An inline link to [Docutils](https://docutils.sourceforge.io/),
a reference-style one to [MyST-Parser][ex-references-myst],
and an autolink, <https://www.sphinx-doc.org/>.

[ex-references-myst]: https://myst-parser.readthedocs.io/

An inline link to Docutils, a reference-style one to MyST-Parser, and an autolink, https://www.sphinx-doc.org/.

Footnotes¶

Footnotes

A numbered footnote [^1] and a named one [^ex-references-myst-note],
referred to twice [^ex-references-myst-note].

[^1]: Numbered in the order it is first referenced.
[^ex-references-myst-note]: Named, and numbered the same way.

A numbered footnote [1] and a named one [2], referred to twice [2].

The two definitions are rendered at the foot of this page.

Documents, terms and {any}¶

Documents, terms and any

See {doc}`rst_basics`, or {doc}`the tables page </authoring/rst_tables>`.
The {term}`MyST specimen term` is defined on another page,
and {any}`authoring_references_footnotes` finds a section by its label.

See reStructuredText basics, or the tables page. The MyST specimen term is defined on another page, and Footnotes finds a section by its label.

Downloads¶

A download

Save {download}`the builders table </../specimens/tables/builders.csv>`
to compare the builders offline.

Save the builders table to compare the builders offline.

Note

ubc build pdf cannot place a {download} link yet (it reports one as build.pdf_block_unsupported), so the PDF shows this specimen’s source only.


[1]

Numbered in the order it is first referenced.

[2] (1,2)

Named, and numbered the same way.

Next
Roles
Previous
References and links
Copyright © 2026, team useblocks
Made with Sphinx and @pradyunsg's Furo
On this page
  • References and links in MyST
    • Targets and {ref}
    • Hyperlinks
    • Footnotes
    • Documents, terms and {any}
    • Downloads