Nix/fix mkdocs#2053
Merged
Merged
Conversation
Adding the documentation virtual env to the devshell packages creates
a conflict on pygmentize with the existing python viruatlenv.
> pkgs.buildEnv error: two given paths contain a conflicting subpath:
> `/nix/store/kvryivzraaa1cw1j3r9zslng9n8nf8lw-python3-3.13.11-env/bin/pygmentize' and
> `/nix/store/yag41lb6wzdj5vh0ikjf072ycf546cc2-python3-3.13.11-env/bin/pygmentize'
> hint: this may be caused by two different versions of the same package in buildEnv's `paths` parameter
> hint: `pkgs.nix-diff` can be used to compare derivations
Instead of authorizing the conflicts in this devshell buildEnv, we
prefer hiding the doc devenv in a separate command to make sure
nothing unexpectally breaks on a nixpkgs update in the future.
The list rendering was broken in a few places. Adding some minor visual tweaks as well.
mkdocs do not support linking to source files living outside of the doc repository. Replacing these dead links with quoted paths.
yvan-sraka
approved these changes
Feb 17, 2026
samrose
approved these changes
Feb 19, 2026
encima
pushed a commit
that referenced
this pull request
Feb 23, 2026
* fix: nix/doc build from devshell
Adding the documentation virtual env to the devshell packages creates
a conflict on pygmentize with the existing python viruatlenv.
> pkgs.buildEnv error: two given paths contain a conflicting subpath:
> `/nix/store/kvryivzraaa1cw1j3r9zslng9n8nf8lw-python3-3.13.11-env/bin/pygmentize' and
> `/nix/store/yag41lb6wzdj5vh0ikjf072ycf546cc2-python3-3.13.11-env/bin/pygmentize'
> hint: this may be caused by two different versions of the same package in buildEnv's `paths` parameter
> hint: `pkgs.nix-diff` can be used to compare derivations
Instead of authorizing the conflicts in this devshell buildEnv, we
prefer hiding the doc devenv in a separate command to make sure
nothing unexpectally breaks on a nixpkgs update in the future.
* fix: nix/doc various nix doc md format issues
The list rendering was broken in a few places. Adding some minor
visual tweaks as well.
* fix: nix/doc add links to orphan pages
* fix: nix/doc, remove dead links
mkdocs do not support linking to source files living outside of the
doc repository. Replacing these dead links with quoted paths.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What kind of change does this PR introduce?
serve-nix-doccommand to the devshell to interactively work on the mkdocs documentation site.Superceding #2052