nixpkgs/doc/contributing-to-documentation.xml

31 lines
1.1 KiB
XML
Raw Normal View History

<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xml:id="chap-contributing">
2018-05-01 23:54:21 +00:00
<title>Contributing to this documentation</title>
<para>
2019-09-18 20:12:54 +00:00
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.
2018-05-01 23:54:21 +00:00
</para>
<para>
You can quickly check your edits with <command>make</command>:
</para>
<screen>
2019-06-17 10:17:16 +00:00
<prompt>$ </prompt>cd /path/to/nixpkgs/doc
<prompt>$ </prompt>nix-shell
<prompt>[nix-shell]$ </prompt>make
</screen>
2018-05-01 23:54:21 +00:00
<para>
2019-09-18 20:12:54 +00:00
If you experience problems, run <command>make debug</command> to help understand the docbook errors.
2018-05-01 23:54:21 +00:00
</para>
<para>
2019-09-18 20:12:54 +00:00
After making modifications to the manual, it's important to build it before committing. You can do that as follows:
2015-06-03 15:03:07 +00:00
<screen>
2019-06-17 10:17:16 +00:00
<prompt>$ </prompt>cd /path/to/nixpkgs/doc
<prompt>$ </prompt>nix-shell
<prompt>[nix-shell]$ </prompt>make clean
<prompt>[nix-shell]$ </prompt>nix-build .
2015-06-03 15:03:07 +00:00
</screen>
2019-09-18 20:12:54 +00:00
If the build succeeds, the manual will be in <filename>./result/share/doc/nixpkgs/manual.html</filename>.
2018-05-01 23:54:21 +00:00
</para>
</chapter>