diff options
| author | Alyssa Ross <hi@alyssa.is> | 2021-08-04 10:43:07 +0000 |
|---|---|---|
| committer | Alyssa Ross <hi@alyssa.is> | 2021-08-04 10:43:07 +0000 |
| commit | 62614cbef7da005c1eda8c9400160f6bcd6546b8 (patch) | |
| tree | c2630f69080637987b68acb1ee8676d2681fe304 /doc/contributing/contributing-to-documentation.xml | |
| parent | d9c82ed3044c72cecf01c6ea042489d30914577c (diff) | |
| parent | e24069138dfec3ef94f211f1da005bb5395adc11 (diff) | |
| download | nixpkgs-62614cbef7da005c1eda8c9400160f6bcd6546b8.tar nixpkgs-62614cbef7da005c1eda8c9400160f6bcd6546b8.tar.gz nixpkgs-62614cbef7da005c1eda8c9400160f6bcd6546b8.tar.bz2 nixpkgs-62614cbef7da005c1eda8c9400160f6bcd6546b8.tar.lz nixpkgs-62614cbef7da005c1eda8c9400160f6bcd6546b8.tar.xz nixpkgs-62614cbef7da005c1eda8c9400160f6bcd6546b8.tar.zst nixpkgs-62614cbef7da005c1eda8c9400160f6bcd6546b8.zip | |
Merge branch 'nixpkgs-update' into master
Diffstat (limited to 'doc/contributing/contributing-to-documentation.xml')
| -rw-r--r-- | doc/contributing/contributing-to-documentation.xml | 30 |
1 files changed, 0 insertions, 30 deletions
diff --git a/doc/contributing/contributing-to-documentation.xml b/doc/contributing/contributing-to-documentation.xml deleted file mode 100644 index b0266043775..00000000000 --- a/doc/contributing/contributing-to-documentation.xml +++ /dev/null @@ -1,30 +0,0 @@ -<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> |