diff options
| author | pennae <82953136+pennae@users.noreply.github.com> | 2023-07-29 23:22:43 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-07-29 23:22:43 +0200 |
| commit | dcd55915ad3945cf6ca6dec55842ec346a77d718 (patch) | |
| tree | 39a751b3e1c6652d963214432b735d9ebb5fed0e /doc/contributing/contributing-to-documentation.chapter.md | |
| parent | 88e78b6a97fb08a35bd65903eab6ec18005472a7 (diff) | |
| parent | 35471bd134022ad66240df22c67e8dd5bcf0a63b (diff) | |
| download | nixlib-dcd55915ad3945cf6ca6dec55842ec346a77d718.tar nixlib-dcd55915ad3945cf6ca6dec55842ec346a77d718.tar.gz nixlib-dcd55915ad3945cf6ca6dec55842ec346a77d718.tar.bz2 nixlib-dcd55915ad3945cf6ca6dec55842ec346a77d718.tar.lz nixlib-dcd55915ad3945cf6ca6dec55842ec346a77d718.tar.xz nixlib-dcd55915ad3945cf6ca6dec55842ec346a77d718.tar.zst nixlib-dcd55915ad3945cf6ca6dec55842ec346a77d718.zip | |
Merge pull request #245358 from asymmetric/nixpkgs-doc-build-instructions
doc/contributing: update build instructions after nrd
Diffstat (limited to 'doc/contributing/contributing-to-documentation.chapter.md')
| -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 0b7b49bf7dda..557473555f8a 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`. @@ -122,5 +110,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/). |