mirror of https://github.com/astral-sh/uv
Move settings reference to reference section (#5689)
Joining #5685 in a dedicated reference section
This commit is contained in:
parent
f107406727
commit
0f30c69624
|
|
@ -42,7 +42,10 @@ pub(crate) struct Args {
|
||||||
pub(crate) fn main(args: &Args) -> Result<()> {
|
pub(crate) fn main(args: &Args) -> Result<()> {
|
||||||
let reference_string = generate();
|
let reference_string = generate();
|
||||||
let filename = "settings.md";
|
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 {
|
match args.mode {
|
||||||
Mode::DryRun => {
|
Mode::DryRun => {
|
||||||
|
|
|
||||||
|
|
@ -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
|
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
|
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).
|
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.
|
||||||
|
|
|
||||||
|
|
@ -6,7 +6,5 @@ Read about the various ways to configure uv:
|
||||||
- [Using environment variables](./environment.md)
|
- [Using environment variables](./environment.md)
|
||||||
- [Configuring authentication](./authentication.md)
|
- [Configuring authentication](./authentication.md)
|
||||||
|
|
||||||
<!-- TODO(zanieb): Move generated settings reference to correct section -->
|
Or, jump to the [settings reference](../reference/settings.md) which enumerates the available configuration
|
||||||
|
|
||||||
Or, jump to the [settings reference](../settings.md) which enumerates the available configuration
|
|
||||||
options.
|
options.
|
||||||
|
|
|
||||||
|
|
@ -104,7 +104,6 @@ nav:
|
||||||
- configuration/index.md
|
- configuration/index.md
|
||||||
- Configuration files: configuration/files.md
|
- Configuration files: configuration/files.md
|
||||||
- Environment variables: configuration/environment.md
|
- Environment variables: configuration/environment.md
|
||||||
- Settings: settings.md
|
|
||||||
- Authentication: configuration/authentication.md
|
- Authentication: configuration/authentication.md
|
||||||
- Integration guides:
|
- Integration guides:
|
||||||
- guides/integration/index.md
|
- guides/integration/index.md
|
||||||
|
|
@ -122,6 +121,7 @@ nav:
|
||||||
- Compatibility with pip: pip/compatibility.md
|
- Compatibility with pip: pip/compatibility.md
|
||||||
- Reference:
|
- Reference:
|
||||||
- Commands: reference/cli.md
|
- Commands: reference/cli.md
|
||||||
|
- Settings: settings.md
|
||||||
- Policies:
|
- Policies:
|
||||||
- Versioning: versioning.md
|
- Versioning: versioning.md
|
||||||
- Platform support: platforms.md
|
- Platform support: platforms.md
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue