Contributing to Nix documentation: Difference between revisions
imported>Fadenb |
imported>Fadenb m →How do I build and test the manual?: syntax highlight |
||
| Line 36: | Line 36: | ||
=== How to build the NixOS manual === | === How to build the NixOS manual === | ||
# In a terminal, navigate to the <tt>/nixpkgs/nixos</tt> directory, where the <tt>doc</tt> directory is located. | # In a terminal, navigate to the <tt>/nixpkgs/nixos</tt> directory, where the <tt>doc</tt> directory is located. | ||
# Run the following command: < | # Run the following command: <syntaxhighlight lang="console" inline>$ nix-build release.nix -A manual.x86_64-linux</syntaxhighlight> | ||
# Open the generated output in a Web browser from the following path: <tt>../nixos/result/share/doc/<project_name>/manual.html</tt> | # Open the generated output in a Web browser from the following path: <tt>../nixos/result/share/doc/<project_name>/manual.html</tt> | ||
=== How to build the Nixpkgs manual === | === How to build the Nixpkgs manual === | ||
# In a terminal, navigate to the <tt>nixpkgs/doc</tt> directory. | # In a terminal, navigate to the <tt>nixpkgs/doc</tt> directory. | ||
# Run the following command: < | # 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> | ||