diff options
| author | Alyssa Ross <hi@alyssa.is> | 2020-01-11 23:37:02 +0000 |
|---|---|---|
| committer | Alyssa Ross <hi@alyssa.is> | 2020-01-11 23:41:30 +0000 |
| commit | 6c557e3f1c28cf87e9fba232811d6875dd1399c1 (patch) | |
| tree | 035a071d5d8980df6de0fa42e2ef8fc0cce7055e /nixpkgs/doc/contributing/contributing-to-documentation.xml | |
| parent | da7500bc026e937ac7fce7b50f67a0e1765737a7 (diff) | |
| parent | e4134747f5666bcab8680aff67fa3b63384f9a0f (diff) | |
| download | nixlib-6c557e3f1c28cf87e9fba232811d6875dd1399c1.tar nixlib-6c557e3f1c28cf87e9fba232811d6875dd1399c1.tar.gz nixlib-6c557e3f1c28cf87e9fba232811d6875dd1399c1.tar.bz2 nixlib-6c557e3f1c28cf87e9fba232811d6875dd1399c1.tar.lz nixlib-6c557e3f1c28cf87e9fba232811d6875dd1399c1.tar.xz nixlib-6c557e3f1c28cf87e9fba232811d6875dd1399c1.tar.zst nixlib-6c557e3f1c28cf87e9fba232811d6875dd1399c1.zip | |
Merge commit 'e4134747f5666bcab8680aff67fa3b63384f9a0f'
Diffstat (limited to 'nixpkgs/doc/contributing/contributing-to-documentation.xml')
| -rw-r--r-- | nixpkgs/doc/contributing/contributing-to-documentation.xml | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/nixpkgs/doc/contributing/contributing-to-documentation.xml b/nixpkgs/doc/contributing/contributing-to-documentation.xml new file mode 100644 index 000000000000..b0266043775f --- /dev/null +++ b/nixpkgs/doc/contributing/contributing-to-documentation.xml @@ -0,0 +1,30 @@ +<chapter xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xml:id="chap-contributing"> + <title>Contributing to this documentation</title> + <para> + The DocBook sources of the Nixpkgs manual are in the <filename +xlink:href="https://github.com/NixOS/nixpkgs/tree/master/doc">doc</filename> subdirectory of the Nixpkgs repository. + </para> + <para> + You can quickly check your edits with <command>make</command>: + </para> +<screen> +<prompt>$ </prompt>cd /path/to/nixpkgs/doc +<prompt>$ </prompt>nix-shell +<prompt>[nix-shell]$ </prompt>make +</screen> + <para> + If you experience problems, run <command>make debug</command> to help understand the docbook errors. + </para> + <para> + After making modifications to the manual, it's important to build it before committing. You can do that as follows: +<screen> +<prompt>$ </prompt>cd /path/to/nixpkgs/doc +<prompt>$ </prompt>nix-shell +<prompt>[nix-shell]$ </prompt>make clean +<prompt>[nix-shell]$ </prompt>nix-build . +</screen> + If the build succeeds, the manual will be in <filename>./result/share/doc/nixpkgs/manual.html</filename>. + </para> +</chapter> |