Move settings reference to reference section

astral-sh · Aug 1, 2024 · 1f5ce90 · 1f5ce90
1 parent 708d6aa
commit 1f5ce90
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 5 deletions.
diff --git 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
@@ -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
@@ -6,7 +6,5 @@ Read about the various ways to configure uv:
 - [Using environment variables](./environment.md)
 - [Configuring authentication](./authentication.md)
 
-<!-- TODO(zanieb): Move generated settings reference to correct section -->
-
-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 → docs/reference/settings.md b/docs/settings.md → docs/reference/settings.md
diff --git 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