alioth/nixpkgs
3
0
Fork 0
forked from mirrors/nixpkgs
Code Releases Activity

doc/contributing: update build instructions

Browse source 
We have moved away from Make since nixos-render-docs was introduced to
build the nixpkgs manual in #239636.
This commit is contained in:
Lorenzo Manacorda 2023-07-25 12:13:01 +02:00
parent c9f9df2f8e
commit 35471bd134
1 changed files with 4 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
doc/contributing/contributing-to-documentation.chapter.md
View file

@ -1,24 +1,12 @@
# Contributing to this documentation {#chap-contributing}
The sources of the Nixpkgs manual are in the [doc](https://github.com/NixOS/nixpkgs/tree/master/doc) subdirectory of the Nixpkgs repository. The manual is still partially written in DocBook but it is progressively being converted to [Markdown](#sec-contributing-markup).
The sources of the Nixpkgs manual are in the [doc](https://github.com/NixOS/nixpkgs/tree/master/doc) subdirectory of the Nixpkgs repository.
You can quickly check your edits with `make`:
You can quickly check your edits with `nix-build`:
```ShellSession
$ cd /path/to/nixpkgs/doc
$ nix-shell
[nix-shell]$ make
```
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:
```ShellSession
$ cd /path/to/nixpkgs/doc
$ nix-shell
[nix-shell]$ make clean
[nix-shell]$ nix-build .
$ cd /path/to/nixpkgs
$ nix-build doc
```
If the build succeeds, the manual will be in `./result/share/doc/nixpkgs/manual.html`.
@ -114,5 +102,3 @@ Additional syntax extensions are available, all of which can be used in NixOS op
>
> watermelon
> : green fruit with red flesh
For contributing to the legacy parts, please see [DocBook: The Definitive Guide](https://tdg.docbook.org/) or the [DocBook rocks! primer](https://web.archive.org/web/20200816233747/https://docbook.rocks/).