Skip to content

Commit b201f3c

Browse files
committed
tweak footnotes
1 parent c8dac09 commit b201f3c

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

docs/mirrors.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -62,18 +62,18 @@ buildcache:
6262
6363
| Field | Required | Description |
6464
|-------|----------|-------------|
65-
| `url` | yes¹ | location of the cache (a `file://` path, or an `http(s)://`, `s3://` or `oci://` URL) |
65+
| `url` | yes[^1]| location of the cache (a `file://` path, or an `http(s)://`, `s3://` or `oci://` URL) |
6666
| `private_key` | no | PGP key used to sign and push packages (see [Keys](#keys)); omit for a read-only cache |
6767
| `public_key` | no | PGP key used to verify downloaded packages |
6868
| `name` | no | name Spack registers the mirror under (default `buildcache`) |
6969
| `mount_specific` | no | store the cache in a per-mount-point sub-directory (default `false`) |
70-
| `fetch` / `push` | no¹ | separate read/write [connections](#connections-and-authentication), used instead of a single `url` |
70+
| `fetch` / `push` | no[^1] | separate read/write [connections](#connections-and-authentication), used instead of a single `url` |
7171
| `binary` | no | the cache holds binary packages (default `true`) |
7272
| `source` | no | the cache also holds package sources (default `false`) |
7373
| `signed` | no | whether Spack signs/verifies binaries with GPG (passed through to Spack) |
7474
| `autopush` | no | Spack pushes each package as soon as it is installed (passed through to Spack) |
7575

76-
¹ Give either a top-level `url` *or* explicit `fetch`/`push` connections — see [Connections and authentication](#connections-and-authentication).
76+
[^1]: Give either a top-level `url` *or* explicit `fetch`/`push` connections — see [Connections and authentication](#connections-and-authentication).
7777

7878
### Read-only build cache
7979

@@ -172,15 +172,13 @@ sourcemirror:
172172

173173
| Field | Required | Description |
174174
|-------|----------|-------------|
175-
| `url` | yes¹ | location of the source mirror |
176-
| `fetch` / `push` | no¹ | separate read/write [connections](#connections-and-authentication), used instead of a single `url` |
175+
| `url` | yes[^1] | location of the source mirror |
176+
| `fetch` / `push` | no[^1] | separate read/write [connections](#connections-and-authentication), used instead of a single `url` |
177177
| `source` | no | the mirror holds package sources (default `true`) |
178178
| `binary` | no | the mirror also holds binary packages (default `false`) |
179179
| `signed` | no | whether Spack signs/verifies binaries with GPG (passed through to Spack) |
180180
| `autopush` | no | Spack pushes to the mirror as soon as a package is installed (passed through to Spack) |
181181

182-
¹ Give either a top-level `url` *or* explicit `fetch`/`push` connections — see [Connections and authentication](#connections-and-authentication).
183-
184182
Source mirrors need no keys: Spack verifies every downloaded source against the checksum in its package recipe, whether it comes from the upstream url or a mirror.
185183

186184
Populate a source mirror on an internet-connected system with Spack:

mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ theme:
1717
features:
1818
- content.code.copy
1919
- content.code.annotate
20+
- content.footnote.tooltips
2021
- navigation.tabs
2122
palette:
2223
primary: deep orange
@@ -25,6 +26,7 @@ plugins:
2526
- autorefs
2627
markdown_extensions:
2728
- attr_list # for internal links
29+
- footnotes
2830
- md_in_html
2931
- admonition
3032
- pymdownx.details

0 commit comments

Comments
 (0)