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

Don't build the API docs in the devshell #11868

Merged

Conversation

edolstra
Copy link
Member

Motivation

A simpler alternative to #11860.

The API docs build is extremely noisy (#11841) and probably not many people care about it anyway. Also, they get rebuilt on every ninja invocation which is generally a waste of time.

Of course, you can still build the docs via nix build .#nix-{internal,external}-api-docs, which is pretty fast.

Context

Priorities and Process

Add 👍 to pull requests you find important.

The Nix maintainer team uses a GitHub project board to schedule and track reviews.

@Ericson2314
Copy link
Member

Can you make it just flip the boolean, so one still has the option without trying to hard of building them in the dev shell?

The API docs build is extremely noisy (NixOS#11841) and probably not many
people care about it anyway. Also, they get rebuild on *every* ninja
invocation which is generally a waste of time.

Of course, you can still build the docs via `nix build
.#nix-{internal,external}-api-docs`, which is pretty fast.
@edolstra
Copy link
Member Author

@Ericson2314 Done!

@Ericson2314 Ericson2314 merged commit 2d153bd into NixOS:master Nov 13, 2024
11 checks passed
@edolstra edolstra deleted the no-api-docs-in-devshell branch November 13, 2024 20:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants