commit a064709342b6adfcafe5bdcff3b5ace453359761 · pyrox.dev/nixpkgs

doc/contributing/contributing-to-documentation.chapter.md

···

       23
       23
        
       

     

       24
       24
        
       If the build succeeds, the manual will be in `./result/share/doc/nixpkgs/manual.html`.

     

       25
       25
        
       

     

       26
       26
       +
       ## devmode {#sec-contributing-devmode}

     

       27
       27
       +
       

     

       28
       28
       +
       The shell in the manual source directory makes available a command, `devmode`.

     

       29
       29
       +
       It is a daemon, that:

     

       30
       30
       +
       1. watches the manual's source for changes and when they occur — rebuilds

     

       31
       31
       +
       2. HTTP serves the manual, injecting a script that triggers reload on changes

     

       32
       32
       +
       3. opens the manual in the default browser

     

       33
       33
       +
       

     

       26
       34
        
       ## Syntax {#sec-contributing-markup}

     

       27
       35
        
       

     

       28
       36
        
       As per [RFC 0072](https://github.com/NixOS/rfcs/pull/72), all new documentation content should be written in [CommonMark](https://commonmark.org/) Markdown dialect.

+20

doc/shell.nix

···

       1
       1
       +
       let

     

       2
       2
       +
         pkgs = import ../. {

     

       3
       3
       +
           config = {};

     

       4
       4
       +
           overlays = [];

     

       5
       5
       +
         };

     

       6
       6
       +
       

     

       7
       7
       +
         common = import ./common.nix;

     

       8
       8
       +
         inherit (common) outputPath indexPath;

     

       9
       9
       +
       

     

       10
       10
       +
         web-devmode = import ../pkgs/tools/nix/web-devmode.nix {

     

       11
       11
       +
           inherit pkgs;

     

       12
       12
       +
           buildArgs = "./.";

     

       13
       13
       +
           open = "/${outputPath}/${indexPath}";

     

       14
       14
       +
         };

     

       15
       15
       +
       in

     

       16
       16
       +
         pkgs.mkShell {

     

       17
       17
       +
           packages = [

     

       18
       18
       +
             web-devmode

     

       19
       19
       +
           ];

     

       20
       20
       +
         }

nixos/doc/manual/contributing-to-this-manual.chapter.md

···

       11
       11
        
       

     

       12
       12
        
       If the build succeeds, the manual will be in `./result/share/doc/nixos/index.html`.

     

       13
       13
        
       

     

       14
       14
       +
       There's also [a convenient development daemon](https://nixos.org/manual/nixpkgs/unstable/#sec-contributing-devmode).

     

       15
       15
       +
       

     

       14
       16
        
       **Contributing to the man pages**

     

       15
       17
        
       

     

       16
       18
        
       The man pages are written in [DocBook] which is XML.

+20

nixos/doc/manual/shell.nix

···

       1
       1
       +
       let

     

       2
       2
       +
         pkgs = import ../../.. {

     

       3
       3
       +
           config = {};

     

       4
       4
       +
           overlays = [];

     

       5
       5
       +
         };

     

       6
       6
       +
       

     

       7
       7
       +
         common = import ./common.nix;

     

       8
       8
       +
         inherit (common) outputPath indexPath;

     

       9
       9
       +
       

     

       10
       10
       +
         web-devmode = import ../../../pkgs/tools/nix/web-devmode.nix {

     

       11
       11
       +
           inherit pkgs;

     

       12
       12
       +
           buildArgs = "../../release.nix -A manualHTML.${builtins.currentSystem}";

     

       13
       13
       +
           open = "/${outputPath}/${indexPath}";

     

       14
       14
       +
         };

     

       15
       15
       +
       in

     

       16
       16
       +
         pkgs.mkShell {

     

       17
       17
       +
           packages = [

     

       18
       18
       +
             web-devmode

     

       19
       19
       +
           ];

     

       20
       20
       +
         }

+117

pkgs/tools/nix/web-devmode.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         pkgs,

     

       3
       3
       +
         # arguments to `nix-build`, e.g. `"foo.nix -A bar"`

     

       4
       4
       +
         buildArgs,

     

       5
       5
       +
         # what path to open a browser at

     

       6
       6
       +
         open,

     

       7
       7
       +
       }: let

     

       8
       8
       +
         inherit (pkgs) lib;

     

       9
       9
       +
       

     

       10
       10
       +
         error_page = pkgs.writeShellScriptBin "error_page" ''

     

       11
       11
       +
           echo "<!DOCTYPE html>

     

       12
       12
       +
           <html>

     

       13
       13
       +
           <head>

     

       14
       14
       +
             <style>

     

       15
       15
       +
               @media (prefers-color-scheme: dark) {

     

       16
       16
       +
                 :root { filter: invert(100%); }

     

       17
       17
       +
               }

     

       18
       18
       +
             </style>

     

       19
       19
       +
           </head>

     

       20
       20
       +
           <body><pre>$1</pre></body>

     

       21
       21
       +
           </html>"

     

       22
       22
       +
         '';

     

       23
       23
       +
       

     

       24
       24
       +
         # The following would have been simpler:

     

       25
       25
       +
         # 1. serve from `$serve`

     

       26
       26
       +
         # 2. pass each build a `--out-link $serve/result`

     

       27
       27
       +
         # But that way live-server does not seem to detect changes and therefore no

     

       28
       28
       +
         # auto-reloads occur.

     

       29
       29
       +
         # Instead, we copy the contents of each build to the `$serve` directory.

     

       30
       30
       +
         # Using rsync here, instead of `cp`, to get as close to an atomic

     

       31
       31
       +
         # directory copy operation as possible. `--delay-updates` should

     

       32
       32
       +
         # also go towards that.

     

       33
       33
       +
         build_and_copy = pkgs.writeShellScriptBin "build_and_copy" ''

     

       34
       34
       +
           set -euxo pipefail

     

       35
       35
       +
       

     

       36
       36
       +
           set +e

     

       37
       37
       +
           stderr=$(2>&1 nix-build --out-link $out_link ${buildArgs})

     

       38
       38
       +
           exit_status=$?

     

       39
       39
       +
           set -e

     

       40
       40
       +
       

     

       41
       41
       +
           if [ $exit_status -eq 0 ];

     

       42
       42
       +
           then

     

       43
       43
       +
             # setting permissions to be able to clean up

     

       44
       44
       +
             ${lib.getBin pkgs.rsync}/bin/rsync \

     

       45
       45
       +
               --recursive \

     

       46
       46
       +
               --chmod=u=rwX \

     

       47
       47
       +
               --delete-before \

     

       48
       48
       +
               --delay-updates \

     

       49
       49
       +
               $out_link/ \

     

       50
       50
       +
               $serve/

     

       51
       51
       +
           else

     

       52
       52
       +
             set +x

     

       53
       53
       +
             ${lib.getBin error_page}/bin/error_page "$stderr" > $error_page_absolute

     

       54
       54
       +
             set -x

     

       55
       55
       +
       

     

       56
       56
       +
             ${lib.getBin pkgs.findutils}/bin/find $serve \

     

       57
       57
       +
               -type f \

     

       58
       58
       +
               ! -name $error_page_relative \

     

       59
       59
       +
               -delete

     

       60
       60
       +
           fi

     

       61
       61
       +
         '';

     

       62
       62
       +
       

     

       63
       63
       +
         # https://watchexec.github.io/

     

       64
       64
       +
         watcher = pkgs.writeShellScriptBin "watcher" ''

     

       65
       65
       +
           set -euxo pipefail

     

       66
       66
       +
       

     

       67
       67
       +
           ${lib.getBin pkgs.watchexec}/bin/watchexec \

     

       68
       68
       +
             --shell=none \

     

       69
       69
       +
             --restart \

     

       70
       70
       +
             --print-events \

     

       71
       71
       +
             ${lib.getBin build_and_copy}/bin/build_and_copy

     

       72
       72
       +
         '';

     

       73
       73
       +
       

     

       74
       74
       +
         # A Rust alternative to live-server exists, but it was not in nixpkgs.

     

       75
       75
       +
         # `--no-css-inject`: without this it seems that only CSS is auto-reloaded.

     

       76
       76
       +
         # https://www.npmjs.com/package/live-server

     

       77
       77
       +
         server = pkgs.writeShellScriptBin "server" ''

     

       78
       78
       +
           set -euxo pipefail

     

       79
       79
       +
       

     

       80
       80
       +
           ${lib.getBin pkgs.nodePackages_latest.live-server}/bin/live-server \

     

       81
       81
       +
             --host=127.0.0.1 \

     

       82
       82
       +
             --verbose \

     

       83
       83
       +
             --no-css-inject \

     

       84
       84
       +
             --entry-file=$error_page_relative \

     

       85
       85
       +
             --open=${open} \

     

       86
       86
       +
             $serve

     

       87
       87
       +
         '';

     

       88
       88
       +
       

     

       89
       89
       +
         devmode =

     

       90
       90
       +
           pkgs.writeShellScriptBin "devmode"

     

       91
       91
       +
           ''

     

       92
       92
       +
             set -euxo pipefail

     

       93
       93
       +
       

     

       94
       94
       +
             function handle_exit {

     

       95
       95
       +
               rm -rf "$tmpdir"

     

       96
       96
       +
             }

     

       97
       97
       +
       

     

       98
       98
       +
             tmpdir=$(mktemp -d)

     

       99
       99
       +
             trap handle_exit EXIT

     

       100
       100
       +
       

     

       101
       101
       +
             export out_link="$tmpdir/result"

     

       102
       102
       +
             export serve="$tmpdir/serve"

     

       103
       103
       +
             mkdir $serve

     

       104
       104
       +
             export error_page_relative=error.html

     

       105
       105
       +
             export error_page_absolute=$serve/$error_page_relative

     

       106
       106
       +
             ${lib.getBin error_page}/bin/error_page "building …" > $error_page_absolute

     

       107
       107
       +
       

     

       108
       108
       +
             ${lib.getBin pkgs.parallel}/bin/parallel \

     

       109
       109
       +
               --will-cite \

     

       110
       110
       +
               --line-buffer \

     

       111
       111
       +
               --tagstr '{/}' \

     

       112
       112
       +
               ::: \

     

       113
       113
       +
               "${lib.getBin watcher}/bin/watcher" \

     

       114
       114
       +
               "${lib.getBin server}/bin/server"

     

       115
       115
       +
           '';

     

       116
       116
       +
       in

     

       117
       117
       +
         devmode