nixpkgs/doc/contributing.xml

21 lines
673 B
XML
Raw Normal View History

<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>
2015-06-03 18:03:07 +03:00
<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. If you make modifications to
the manual, it's important to build it before committing. You can do that as follows:
2015-06-03 18:03:07 +03:00
<screen>
$ cd /path/to/nixpkgs
$ nix-build doc
</screen>
2015-06-03 18:03:07 +03:00
If the build succeeds, the manual will be in
<filename>./result/share/doc/nixpkgs/manual.html</filename>.</para>
</chapter>