From 1f5ce907ad9cb1ddd7a18f25e2ca9f6a30c97dad Mon Sep 17 00:00:00 2001 From: Zanie Blue Date: Thu, 1 Aug 2024 10:04:21 -0500 Subject: [PATCH] Move settings reference to reference section --- crates/uv-dev/src/generate_options_reference.rs | 5 ++++- docs/configuration/files.md | 4 ++++ docs/configuration/index.md | 4 +--- docs/{ => reference}/settings.md | 0 mkdocs.template.yml | 2 +- 5 files changed, 10 insertions(+), 5 deletions(-) rename docs/{ => reference}/settings.md (100%) diff --git a/crates/uv-dev/src/generate_options_reference.rs b/crates/uv-dev/src/generate_options_reference.rs index 0ff5589f41128..66010ee99ae98 100644 --- a/crates/uv-dev/src/generate_options_reference.rs +++ b/crates/uv-dev/src/generate_options_reference.rs @@ -42,7 +42,10 @@ pub(crate) struct Args { pub(crate) fn main(args: &Args) -> Result<()> { let reference_string = generate(); let filename = "settings.md"; - let reference_path = PathBuf::from(ROOT_DIR).join("docs").join(filename); + let reference_path = PathBuf::from(ROOT_DIR) + .join("docs") + .join("reference") + .join(filename); match args.mode { Mode::DryRun => { diff --git a/docs/configuration/files.md b/docs/configuration/files.md index 8411367f293c3..5320e44a1448f 100644 --- a/docs/configuration/files.md +++ b/docs/configuration/files.md @@ -43,3 +43,7 @@ persistent configuration. uv also accepts a `--config-file` command-line argument, which accepts a path to a `uv.toml` to use as the configuration file. When provided, this file will be used in place of _any_ discovered configuration files (e.g., user-level configuration will be ignored). + +## Settings + +See the [settings reference](../reference/settings.md) for an enumeration of the available settings. diff --git a/docs/configuration/index.md b/docs/configuration/index.md index 463d00a9c01b9..a68cb6399fe01 100644 --- a/docs/configuration/index.md +++ b/docs/configuration/index.md @@ -6,7 +6,5 @@ Read about the various ways to configure uv: - [Using environment variables](./environment.md) - [Configuring authentication](./authentication.md) - - -Or, jump to the [settings reference](../settings.md) which enumerates the available configuration +Or, jump to the [settings reference](../reference/settings.md) which enumerates the available configuration options. diff --git a/docs/settings.md b/docs/reference/settings.md similarity index 100% rename from docs/settings.md rename to docs/reference/settings.md diff --git a/mkdocs.template.yml b/mkdocs.template.yml index bc86c47eecbc2..294ab07f8520b 100644 --- a/mkdocs.template.yml +++ b/mkdocs.template.yml @@ -104,7 +104,6 @@ nav: - configuration/index.md - Configuration files: configuration/files.md - Environment variables: configuration/environment.md - - Settings: settings.md - Authentication: configuration/authentication.md - Integration guides: - guides/integration/index.md @@ -122,6 +121,7 @@ nav: - Compatibility with pip: pip/compatibility.md - Reference: - Commands: reference/cli.md + - Settings: settings.md - Policies: - Versioning: versioning.md - Platform support: platforms.md