Contributing to Nix documentation: Difference between revisions
imported>Fadenb m →How do I build and test the manual?: syntax highlight |
imported>Mic92 |
||
| Line 43: | Line 43: | ||
# Run the following command: <syntaxhighlight lang="console" inline>$ nix-build</syntaxhighlight> | # Run the following command: <syntaxhighlight lang="console" inline>$ nix-build</syntaxhighlight> | ||
# Open the generated output in a Web browser from the following path: <tt>../nixpkgs/result/share/doc/<project_name>/manual.html</tt> | # Open the generated output in a Web browser from the following path: <tt>../nixpkgs/result/share/doc/<project_name>/manual.html</tt> | ||
=== How to build the Nix manual === | |||
In the [https://github.com/NixOS/nix Nix] repository run the following command once | |||
to configure the project: | |||
<syntaxhighlight lang="console">$ nix-shell --command 'autoreconf --install && ./configure --enable-doc-gen'</syntaxhighlight> | |||
To build the actual documentation run the following command: | |||
<syntaxhighlight lang="console">$ nix-shell --command 'make doc/manual/manual.html'</syntaxhighlight> | |||
<code>doc/manual/manual.html</code> can be then opened in a browser. | |||