diff options
| author | Lorenzo Manacorda <lorenzo@mailbox.org> | 2023-07-25 12:13:01 +0200 |
|---|---|---|
| committer | Lorenzo Manacorda <lorenzo@mailbox.org> | 2023-07-25 15:26:18 +0200 |
| commit | 35471bd134022ad66240df22c67e8dd5bcf0a63b (patch) | |
| tree | ddd46e550959f4a6bfd4fd6dba01b68700899904 /doc/contributing | |
| parent | c9f9df2f8eff13e7577b3a143e3c47b5223e8084 (diff) | |
doc/contributing: update build instructions
We have moved away from Make since nixos-render-docs was introduced to build the nixpkgs manual in #239636.
Diffstat (limited to 'doc/contributing')
| -rw-r--r-- | doc/contributing/contributing-to-documentation.chapter.md | 22 |
1 files changed, 4 insertions, 18 deletions
diff --git a/doc/contributing/contributing-to-documentation.chapter.md b/doc/contributing/contributing-to-documentation.chapter.md index a732eee4b9627..800cd7f161ff1 100644 --- a/doc/contributing/contributing-to-documentation.chapter.md +++ b/doc/contributing/contributing-to-documentation.chapter.md @@ -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/). |