diff --git a/site/mkdocs.yml b/site/mkdocs.yml index 8374bb4ba03..bcd0b6aaa36 100644 --- a/site/mkdocs.yml +++ b/site/mkdocs.yml @@ -12,9 +12,7 @@ theme: name: material custom_dir: overrides features: - - navigation.tabs - navigation.sections - - navigation.indexes - navigation.footer - navigation.instant - navigation.instant.progress @@ -67,60 +65,58 @@ hooks: - overrides/hooks/shortcodes.py nav: - - Home: - - index.md - - "Installation": - - "Pre-built binaries": docs/installation/pre-built-binaries.md - - docs/installation/from-source.md - - docs/installation/updating.md + - index.md + - "Getting started": + - "Pre-built binaries": docs/installation/pre-built-binaries.md + - docs/installation/from-source.md + - docs/installation/updating.md - "Platform-specific notes": - docs/installation/windows.md - docs/installation/macos.md - docs/installation/release-urls.md - - changelog.md - - Usage: + - "Using nextest": - docs/running.md - docs/listing.md - docs/reporting.md - - "Features": - - docs/features/retries.md - - docs/features/slow-tests.md + - "Features": + - docs/features/retries.md + - docs/features/slow-tests.md + - "More features": - docs/features/leaky-tests.md - docs/features/target-runners.md - - "Features for CI": - docs/ci-features/archiving.md - "Partitioning/sharding runs": docs/ci-features/partitioning.md - "Filterset DSL": - - docs/filtersets/index.md + - "About filtersets": docs/filtersets/index.md - "DSL reference": docs/filtersets/reference.md - - Configuration: - - docs/configuration/index.md - - docs/configuration/per-test-overrides.md + - "Integrations": + - "Overview": docs/integrations/index.md + - docs/integrations/test-coverage.md + - "Miri interpreter": docs/integrations/miri.md + - docs/integrations/criterion.md + - "cargo-mutants": docs/integrations/cargo-mutants.md + - Configuration: + - "Configuring nextest": docs/configuration/index.md + - docs/configuration/per-test-overrides.md + - "More configuration": - "Specifying platforms": docs/configuration/specifying-platforms.md - "Environment variables": docs/configuration/env-vars.md - "Minimum versions": docs/configuration/minimum-versions.md - "Heavy tests": docs/configuration/threads-required.md - "Mutual exclusion and rate-limiting": docs/configuration/test-groups.md - docs/configuration/setup-scripts.md - - Machine-readable output: - - docs/machine-readable/index.md + - Machine-readable output: + - "About output formats": docs/machine-readable/index.md + - "JUnit support": docs/machine-readable/junit.md + - "More formats": - "Test and binary lists": docs/machine-readable/list.md - - "JUnit support": docs/machine-readable/junit.md - docs/machine-readable/libtest-json.md - - "Integrations": - - docs/integrations/index.md - - docs/integrations/test-coverage.md - - "Miri interpreter": docs/integrations/miri.md - - docs/integrations/criterion.md - - "cargo-mutants": docs/integrations/cargo-mutants.md - - "Stability policy": - - docs/stability/index.md - - "Design": - - docs/design/how-it-works.md - - docs/design/custom-test-harnesses.md - - Benchmarks: - - docs/benchmarks/index.md - - "Crates.io": "https://crates.io/crates/cargo-nextest" + - "Stability policy": docs/stability/index.md + - "Design": + - docs/design/how-it-works.md + - docs/design/custom-test-harnesses.md + - "Benchmarks": docs/benchmarks/index.md + - changelog.md markdown_extensions: # Python Markdown diff --git a/site/src/docs/benchmarks/index.md b/site/src/docs/benchmarks/index.md index 75c63483d4d..256e5eaab01 100644 --- a/site/src/docs/benchmarks/index.md +++ b/site/src/docs/benchmarks/index.md @@ -1,3 +1,7 @@ +--- +icon: material/speedometer +--- + # Benchmarks 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: diff --git a/site/src/docs/configuration/index.md b/site/src/docs/configuration/index.md index 2b6dcb8ba9e..df364068973 100644 --- a/site/src/docs/configuration/index.md +++ b/site/src/docs/configuration/index.md @@ -1,4 +1,8 @@ -# Configuration +--- +icon: material/tune +--- + +# Configuring nextest 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. diff --git a/site/src/docs/filtersets/index.md b/site/src/docs/filtersets/index.md index be156c7cf92..4819b7ec09a 100644 --- a/site/src/docs/filtersets/index.md +++ b/site/src/docs/filtersets/index.md @@ -1,3 +1,7 @@ +--- +icon: material/account-filter +--- + # Filterset DSL 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). diff --git a/site/src/docs/integrations/index.md b/site/src/docs/integrations/index.md index 64e6bb7d198..d4965998cb3 100644 --- a/site/src/docs/integrations/index.md +++ b/site/src/docs/integrations/index.md @@ -1,3 +1,7 @@ +--- +icon: material/vector-combine +--- + # Integrations with other tools A number of other tools in the Rust ecosystem have integrated with nextest. Some of the more prominent ones are: diff --git a/site/src/docs/machine-readable/index.md b/site/src/docs/machine-readable/index.md index e3515e6c2fd..4be15066cb3 100644 --- a/site/src/docs/machine-readable/index.md +++ b/site/src/docs/machine-readable/index.md @@ -1,4 +1,8 @@ -# Machine-readable output +--- +icon: material/message-processing-outline +--- + +# Machine-readable output formats Nextest provides a number of ways to obtain output suitable for consumption by other tools or infrastructure. diff --git a/site/src/docs/stability/index.md b/site/src/docs/stability/index.md index 22fc6d3b64f..93e23d12837 100644 --- a/site/src/docs/stability/index.md +++ b/site/src/docs/stability/index.md @@ -1,3 +1,7 @@ +--- +icon: material/ship-wheel +--- + # Stability policy This section contains information on how cargo-nextest will evolve in a backwards-compatible way over time. diff --git a/site/src/index.md b/site/src/index.md index 5ee7fa3c799..e62c6be990c 100644 --- a/site/src/index.md +++ b/site/src/index.md @@ -1,6 +1,7 @@ --- -title: Nextest +title: Home description: A next-generation test runner for Rust. +icon: material/home --- # cargo-nextest @@ -17,7 +18,7 @@ Welcome to the home page for **cargo-nextest**, a next-generation test runner fo - **[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. - **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. - **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). -- **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). +- **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). - **Designed for CI.** Nextest addresses real-world pain points in continuous integration scenarios: - Use **[pre-built binaries](docs/installation/pre-built-binaries.md)** for quick installation. - Set up CI-specific **[configuration profiles](docs/configuration/index.md)**. diff --git a/site/src/theme/css/extra.css b/site/src/theme/css/extra.css index 37c120ea1cc..f680ba07ee8 100644 --- a/site/src/theme/css/extra.css +++ b/site/src/theme/css/extra.css @@ -1,6 +1,7 @@ :root { --md-status--experimental: url('data:image/svg+xml;charset=utf-8,'); --md-primary-fg-color: #045; + --md-primary-fg-color--dark: #045; } .md-status--experimental::after {