Glossary, index, confval and envvar in MyST¶

The MyST forms of the specimens on Glossary, index, confval and envvar, each rendered live by this page’s own Markdown parser. Their terms and objects carry names of their own, because a term or object defined twice in one project is reported.

Glossaries¶

A glossary

```{glossary}
MyST specimen term
MyST sample term
   A term defined on this page; both spellings link here.
```

See the {term}`MyST specimen term`, also spelled {term}`MyST sample term`.

MyST specimen term¶
MyST sample term¶: A term defined on this page; both spellings link here.

See the MyST specimen term, also spelled MyST sample term.

Index entries¶

Index entries

```{index} pair: specimen; index entry
```

This paragraph carries the directive's entry,
and the {index}`role <single: specimen; index role>` files one of its own.

This paragraph carries the directive’s entry, and the role files one of its own.

Note

ubc build pdf cannot place an index directive yet (it reports one as build.pdf_block_unsupported), so the PDF shows this specimen’s source only.

Configuration values¶

A configuration value

```{confval} ex_myst_greeting
:type: `str`
:default: `"Hello"`

The word a specimen greets with.
```

Set {confval}`ex_myst_greeting` to change the greeting.

ex_myst_greeting¶

Type:: str
Default:: "Hello"

The word a specimen greets with.

Set ex_myst_greeting to change the greeting.

Environment variables¶

An environment variable

```{envvar} EX_MYST_GREETING_HOME
The directory a specimen reads its greetings from.
```

Point {envvar}`EX_MYST_GREETING_HOME` at another directory to change it.

EX_MYST_GREETING_HOME¶: The directory a specimen reads its greetings from.

Point EX_MYST_GREETING_HOME at another directory to change it.