Skip to content

Commit cd02fa2

Browse files
committed
[site] make more mobile friendly
Our navigation looked a bit off on mobile -- mobile and top-level tabs don't seem to go well. Instead, just put everything on the left for now.
1 parent 67f1aae commit cd02fa2

File tree

9 files changed

+61
-39
lines changed

9 files changed

+61
-39
lines changed

site/mkdocs.yml

Lines changed: 31 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,7 @@ theme:
1212
name: material
1313
custom_dir: overrides
1414
features:
15-
- navigation.tabs
1615
- navigation.sections
17-
- navigation.indexes
1816
- navigation.footer
1917
- navigation.instant
2018
- navigation.instant.progress
@@ -67,60 +65,58 @@ hooks:
6765
- overrides/hooks/shortcodes.py
6866

6967
nav:
70-
- Home:
71-
- index.md
72-
- "Installation":
73-
- "Pre-built binaries": docs/installation/pre-built-binaries.md
74-
- docs/installation/from-source.md
75-
- docs/installation/updating.md
68+
- index.md
69+
- "Getting started":
70+
- "Pre-built binaries": docs/installation/pre-built-binaries.md
71+
- docs/installation/from-source.md
72+
- docs/installation/updating.md
7673
- "Platform-specific notes":
7774
- docs/installation/windows.md
7875
- docs/installation/macos.md
7976
- docs/installation/release-urls.md
80-
- changelog.md
81-
- Usage:
77+
- "Using nextest":
8278
- docs/running.md
8379
- docs/listing.md
8480
- docs/reporting.md
85-
- "Features":
86-
- docs/features/retries.md
87-
- docs/features/slow-tests.md
81+
- "Features":
82+
- docs/features/retries.md
83+
- docs/features/slow-tests.md
84+
- "More features":
8885
- docs/features/leaky-tests.md
8986
- docs/features/target-runners.md
90-
- "Features for CI":
9187
- docs/ci-features/archiving.md
9288
- "Partitioning/sharding runs": docs/ci-features/partitioning.md
9389
- "Filterset DSL":
94-
- docs/filtersets/index.md
90+
- "About filtersets": docs/filtersets/index.md
9591
- "DSL reference": docs/filtersets/reference.md
96-
- Configuration:
97-
- docs/configuration/index.md
98-
- docs/configuration/per-test-overrides.md
92+
- "Integrations":
93+
- "Overview": docs/integrations/index.md
94+
- docs/integrations/test-coverage.md
95+
- "Miri interpreter": docs/integrations/miri.md
96+
- docs/integrations/criterion.md
97+
- "cargo-mutants": docs/integrations/cargo-mutants.md
98+
- Configuration:
99+
- "Configuring nextest": docs/configuration/index.md
100+
- docs/configuration/per-test-overrides.md
101+
- "More configuration":
99102
- "Specifying platforms": docs/configuration/specifying-platforms.md
100103
- "Environment variables": docs/configuration/env-vars.md
101104
- "Minimum versions": docs/configuration/minimum-versions.md
102105
- "Heavy tests": docs/configuration/threads-required.md
103106
- "Mutual exclusion and rate-limiting": docs/configuration/test-groups.md
104107
- docs/configuration/setup-scripts.md
105-
- Machine-readable output:
106-
- docs/machine-readable/index.md
108+
- Machine-readable output:
109+
- "About output formats": docs/machine-readable/index.md
110+
- "JUnit support": docs/machine-readable/junit.md
111+
- "More formats":
107112
- "Test and binary lists": docs/machine-readable/list.md
108-
- "JUnit support": docs/machine-readable/junit.md
109113
- docs/machine-readable/libtest-json.md
110-
- "Integrations":
111-
- docs/integrations/index.md
112-
- docs/integrations/test-coverage.md
113-
- "Miri interpreter": docs/integrations/miri.md
114-
- docs/integrations/criterion.md
115-
- "cargo-mutants": docs/integrations/cargo-mutants.md
116-
- "Stability policy":
117-
- docs/stability/index.md
118-
- "Design":
119-
- docs/design/how-it-works.md
120-
- docs/design/custom-test-harnesses.md
121-
- Benchmarks:
122-
- docs/benchmarks/index.md
123-
- "Crates.io": "https://crates.io/crates/cargo-nextest"
114+
- "Stability policy": docs/stability/index.md
115+
- "Design":
116+
- docs/design/how-it-works.md
117+
- docs/design/custom-test-harnesses.md
118+
- "Benchmarks": docs/benchmarks/index.md
119+
- changelog.md
124120

125121
markdown_extensions:
126122
# Python Markdown

site/src/docs/benchmarks/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
icon: material/speedometer
3+
---
4+
15
# Benchmarks
26

37
Nextest's [execution model](../design/how-it-works.md) generally leads to faster test runs than Cargo. How much faster depends on the specifics, but here are some general guidelines:

site/src/docs/configuration/index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Configuration
1+
---
2+
icon: material/tune
3+
---
4+
5+
# Configuring nextest
26

37
cargo-nextest supports repository-specific configuration at the location `.config/nextest.toml` from the Cargo workspace root. The location of the configuration file can be overridden with the `--config-file` option.
48

site/src/docs/filtersets/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
icon: material/account-filter
3+
---
4+
15
# Filterset DSL
26

37
Nextest supports a domain-specific language (DSL) for choosing sets of tests called **filtersets** (formerly **filter expressions**). The DSL is inspired by, and is similar to, [Bazel query](https://bazel.build/docs/query-how-to) and [Mercurial revsets](https://www.mercurial-scm.org/repo/hg/help/revsets).

site/src/docs/integrations/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
icon: material/vector-combine
3+
---
4+
15
# Integrations with other tools
26

37
A number of other tools in the Rust ecosystem have integrated with nextest. Some of the more prominent ones are:

site/src/docs/machine-readable/index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Machine-readable output
1+
---
2+
icon: material/message-processing-outline
3+
---
4+
5+
# Machine-readable output formats
26

37
Nextest provides a number of ways to obtain output suitable for consumption by other tools or infrastructure.
48

site/src/docs/stability/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
icon: material/ship-wheel
3+
---
4+
15
# Stability policy
26

37
This section contains information on how cargo-nextest will evolve in a backwards-compatible way over time.

site/src/index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
2-
title: Nextest
2+
title: Home
33
description: A next-generation test runner for Rust.
4+
icon: material/home
45
---
56

67
# cargo-nextest
@@ -17,7 +18,7 @@ Welcome to the home page for **cargo-nextest**, a next-generation test runner fo
1718
- **[Up to 3× as fast](docs/benchmarks/index.md) as cargo test.** Nextest uses a [state-of-the-art execution model](docs/design/how-it-works.md) for faster, more reliable test runs.
1819
- **Identify [slow](docs/features/slow-tests.md) and [leaky](docs/features/leaky-tests.md) tests.** Use nextest to detect misbehaving tests, identify bottlenecks during test execution, and optionally terminate tests if they take too long.
1920
- **Filter tests using an embedded language.** Use powerful [filtersets](docs/filtersets/index.md) to specify granular subsets of tests on the command-line, and to enable [per-test overrides](docs/configuration/per-test-overrides.md).
20-
- **Configure [per-test settings](docs/configuration/per-test-overrides.md)**. [Automatically retry](docs/features/retries.md#per-test-overrides) subsets of tests, mark them as [heavy](docs/configuration/threads-required.md), or [run them serially](docs/configuration/test-groups.md).
21+
- **Configure [per-test settings](docs/configuration/per-test-overrides.md)**. [Automatically retry](docs/features/retries.md#per-test-settings) subsets of tests, mark them as [heavy](docs/configuration/threads-required.md), or [run them serially](docs/configuration/test-groups.md).
2122
- **Designed for CI.** Nextest addresses real-world pain points in continuous integration scenarios:
2223
- Use **[pre-built binaries](docs/installation/pre-built-binaries.md)** for quick installation.
2324
- Set up CI-specific **[configuration profiles](docs/configuration/index.md)**.

site/src/theme/css/extra.css

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
:root {
22
--md-status--experimental: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M5 19a1 1 0 0 0 1 1h12a1 1 0 0 0 1-1c0-.21-.07-.41-.18-.57L13 8.35V4h-2v4.35L5.18 18.43c-.11.16-.18.36-.18.57m1 3a3 3 0 0 1-3-3c0-.6.18-1.16.5-1.63L9 7.81V6a1 1 0 0 1-1-1V4a2 2 0 0 1 2-2h4a2 2 0 0 1 2 2v1a1 1 0 0 1-1 1v1.81l5.5 9.56c.32.47.5 1.03.5 1.63a3 3 0 0 1-3 3H6m7-6 1.34-1.34L16.27 18H7.73l2.66-4.61L13 16m-.5-4a.5.5 0 0 1 .5.5.5.5 0 0 1-.5.5.5.5 0 0 1-.5-.5.5.5 0 0 1 .5-.5Z"></path></svg>');
33
--md-primary-fg-color: #045;
4+
--md-primary-fg-color--dark: #045;
45
}
56

67
.md-status--experimental::after {

0 commit comments

Comments
 (0)