doc/contributing: update build instructions after nrd #245358
Merged
Conversation
This file contains 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
github-actions
bot
added
the
8.has: documentation
asymmetric
force-pushed
the
nixpkgs-doc-build-instructions
branch
4 times, most recently
from
34ed590 to
e49e3f8
Compare
asymmetric
changed the title
asymmetric
force-pushed
the
nixpkgs-doc-build-instructions
branch
from
e49e3f8 to
3d303fa
Compare
asymmetric
added
the
6.topic: documentation
ofborg
bot
added
10.rebuild-darwin: 0
pennae
reviewed
Jul 25, 2023
asymmetric
force-pushed
the
nixpkgs-doc-build-instructions
branch
from
3d303fa to
5d9e5ef
Compare
We have moved away from Make since nixos-render-docs was introduced to build the nixpkgs manual in NixOS#239636.
asymmetric
force-pushed
the
nixpkgs-doc-build-instructions
branch
from
5d9e5ef to
35471bd
Compare
pennae
approved these changes
Jul 26, 2023
|
|
||
| If you experience problems, run `make debug` to help understand the docbook errors. | ||
|
|
||
| After making modifications to the manual, it's important to build it before committing. You can do that as follows: |
There was a problem hiding this comment.
just notice that this message went away. not sure how necessary it is anymore since markdown literally does not have a concept of invalid syntax (and egregious nrd-extension errors would be caught by CI).
fricklerhandwerk
approved these changes
Jul 27, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
We have moved away from Make since nixos-render-docs was introduced to
build the nixpkgs manual in #239636.
Description of changes
Things done
sandbox = trueset innix.conf? (See Nix manual)nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage./result/bin/)