Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Disable collapsible navigation in the documentation #5674

Merged
merged 2 commits into from
Aug 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/getting-started/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Getting started

To help you get started with uv, we'll cover a few important topics:

- [Installing uv](./installation.md)
- [First steps after installation](./first-steps.md)
- [An overview of uv's features](./features.md)
- [How to get help](./help.md)

Read on, or jump ahead to another section:

- Get going quickly with [guides](../guides/index.md) for common workflows.
- Learn more about the core [concepts](../concepts/index.md) in uv.
- Use the [reference](../reference/index.md) documentation to find details about something specific.
11 changes: 11 additions & 0 deletions docs/reference/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Reference

The reference section provides information about specific parts of uv:

- [Commands](./cli.md): A reference for uv's command line interface.
- [Settings](./settings.md): A reference for uv's configuration schema.
- [Resolver](./resolver-internals.md): Details about the internals of uv's resolver.
- [Versioning](./versioning.md): uv's versioning policy.
- [Platform support](./platforms.md): uv's supported operating systems and architectures.

Looking for a broader overview? Check out the [concepts](../concepts/index.md) documentation.
20 changes: 20 additions & 0 deletions docs/stylesheets/extra.css
Original file line number Diff line number Diff line change
Expand Up @@ -126,10 +126,14 @@ See https://github.com/astral-sh/uv/issues/5130 */
}
}


/* Reducing spacing between nav items to fit more content */
.md-nav__link {
margin-top: 0.25em;
}
.md-nav__item--section {
margin: 0.75em 0;
}
/* Retain larger spacing for each top-level section in the nav */
.md-nav__item--nested {
margin-top: 0.6em;
Expand All @@ -143,6 +147,22 @@ See https://github.com/astral-sh/uv/issues/5130 */
user-select: none;
}

/* Increase the size of the sections headings, remove the bold */
.md-nav__item--section>.md-nav__link {
font-size: 16px;
font-weight: normal;
}
/* Increase the size of the index nav item to match the sections */
.md-nav__item:first-child {
font-size: 16px;
font-weight: normal;
}
/* But do not increase the size of other nav items */
.md-nav__item--section > .md-nav > .md-nav__list > .md-nav__item {
font-size: 14px;
font-weight: normal;
}

/* Bold the active nav link for accessibility */
.md-nav__link--active {
font-weight: bold;
Expand Down
4 changes: 3 additions & 1 deletion mkdocs.template.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ theme:
- navigation.instant
- navigation.instant.prefetch
- navigation.instant.progress
- navigation.expand
- navigation.sections
- navigation.indexes
- navigation.tracking
- content.code.annotate
Expand Down Expand Up @@ -82,6 +82,7 @@ extra:
nav:
- Introduction: index.md
- Getting started:
- getting-started/index.md
- Installation: getting-started/installation.md
- First steps: getting-started/first-steps.md
- Features: getting-started/features.md
Expand Down Expand Up @@ -122,6 +123,7 @@ nav:
- Locking environments: pip/compile.md
- Compatibility with pip: pip/compatibility.md
- Reference:
- reference/index.md
- Commands: reference/cli.md
- Settings: reference/settings.md
- Resolver: reference/resolver-internals.md
Expand Down
Loading