commit 8b7f0e559ad9419815d0a4c8d231e2bf464c0ad2 · pyrox.dev/nixpkgs

+33 -59

nixos/doc/manual/default.nix

···

       68
       68
        
             optionIdPrefix = "test-opt-";

     

       69
       69
        
           };

     

       70
       70
        
       

     

       71
       71
       -
         sources = runCommand "manual-sources" {

     

       72
       72
       -
           inputs = lib.sourceFilesBySuffices ./. [ ".xml" ".md" ];

     

       73
       73
       -
           nativeBuildInputs = [ pkgs.nixos-render-docs ];

     

       74
       74
       -
         } ''

     

       75
       75
       -
           mkdir $out

     

       76
       76
       -
           cd $out

     

       77
       77
       -
           cp -r --no-preserve=all $inputs/* .

     

       78
       78
       -
       

     

       79
       79
       -
           declare -a convert_args

     

       80
       80
       -
           while read -r mf; do

     

       81
       81
       -
             if [[ "$mf" = *.chapter.md ]]; then

     

       82
       82
       -
               convert_args+=("--chapter")

     

       83
       83
       -
             else

     

       84
       84
       -
               convert_args+=("--section")

     

       85
       85
       -
             fi

     

       86
       86
       -
       

     

       87
       87
       -
             convert_args+=("from_md/''${mf%.md}.xml" "$mf")

     

       88
       88
       -
           done < <(find . -type f -name '*.md')

     

       89
       89
       -
       

     

       90
       90
       -
           nixos-render-docs manual docbook-fragment \

     

       91
       91
       -
             --manpage-urls ${manpageUrls} \

     

       92
       92
       -
             "''${convert_args[@]}"

     

       93
       93
       -
         '';

     

       94
       94
       -
       

     

       95
       95
       -
         modulesDoc = runCommand "modules.xml" {

     

       96
       96
       -
           nativeBuildInputs = [ pkgs.nixos-render-docs ];

     

       97
       97
       -
         } ''

     

       98
       98
       -
           nixos-render-docs manual docbook-section \

     

       99
       99
       -
             --manpage-urls ${manpageUrls} \

     

       100
       100
       -
             "$out" \

     

       101
       101
       -
             --section \

     

       102
       102
       -
               --section-id modules \

     

       103
       103
       -
               --chapters ${lib.concatMapStrings (p: "${p.value} ") config.meta.doc}

     

       104
       104
       -
         '';

     

       105
       105
       -
       

     

       106
       106
       -
         generatedSources = runCommand "generated-docbook" {} ''

     

       107
       107
       -
           mkdir $out

     

       108
       108
       -
           ln -s ${modulesDoc} $out/modules.xml

     

       109
       109
       -
           ln -s ${optionsDoc.optionsDocBook} $out/options-db.xml

     

       110
       110
       -
           ln -s ${testOptionsDoc.optionsDocBook} $out/test-options-db.xml

     

       111
       111
       -
           printf "%s" "${version}" > $out/version

     

       112
       112
       -
         '';

     

       113
       113
       -
       

     

       114
       114
       -
         copySources =

     

       115
       115
       -
           ''

     

       116
       116
       -
             cp -prd $sources/* . # */

     

       117
       117
       -
             ln -s ${generatedSources} ./generated

     

       118
       118
       -
             chmod -R u+w .

     

       119
       119
       -
           '';

     

       120
       120
       -
       

     

       121
       71
        
         toc = builtins.toFile "toc.xml"

     

       122
       72
        
           ''

     

       123
       73
        
             <toc role="chunk-toc">

     
···

       186
       136
        
         '';

     

       187
       137
        
       

     

       188
       138
        
         manual-combined = runCommand "nixos-manual-combined"

     

       189
       189
       -
           { inherit sources;

     

       190
       190
       -
             nativeBuildInputs = [ buildPackages.libxml2.bin buildPackages.libxslt.bin ];

     

       139
       139
       +
           { inputs = lib.sourceFilesBySuffices ./. [ ".xml" ".md" ];

     

       140
       140
       +
             nativeBuildInputs = [ pkgs.nixos-render-docs pkgs.libxml2.bin pkgs.libxslt.bin ];

     

       191
       141
        
             meta.description = "The NixOS manual as plain docbook XML";

     

       192
       142
        
           }

     

       193
       143
        
           ''

     

       194
       194
       -
             ${copySources}

     

       144
       144
       +
             cp -r --no-preserve=all $inputs/* .

     

       145
       145
       +
       

     

       146
       146
       +
             declare -a convert_args

     

       147
       147
       +
             while read -r mf; do

     

       148
       148
       +
               if [[ "$mf" = *.chapter.md ]]; then

     

       149
       149
       +
                 convert_args+=("--chapter")

     

       150
       150
       +
               else

     

       151
       151
       +
                 convert_args+=("--section")

     

       152
       152
       +
               fi

     

       153
       153
       +
       

     

       154
       154
       +
               convert_args+=("from_md/''${mf%.md}.xml" "$mf")

     

       155
       155
       +
             done < <(find . -type f -name '*.md')

     

       156
       156
       +
       

     

       157
       157
       +
             nixos-render-docs manual docbook-fragment \

     

       158
       158
       +
               --manpage-urls ${manpageUrls} \

     

       159
       159
       +
               "''${convert_args[@]}"

     

       160
       160
       +
       

     

       161
       161
       +
             mkdir ./generated

     

       162
       162
       +
             ln -s ${optionsDoc.optionsDocBook} ./generated/options-db.xml

     

       163
       163
       +
             ln -s ${testOptionsDoc.optionsDocBook} ./generated/test-options-db.xml

     

       164
       164
       +
             printf "%s" "${version}" > ./generated/version

     

       165
       165
       +
             chmod -R u+w .

     

       166
       166
       +
       

     

       167
       167
       +
             nixos-render-docs manual docbook-section \

     

       168
       168
       +
               --manpage-urls ${manpageUrls} \

     

       169
       169
       +
               ./generated/modules.xml \

     

       170
       170
       +
               --section \

     

       171
       171
       +
                 --section-id modules \

     

       172
       172
       +
                 --chapters ${lib.concatMapStrings (p: "${p.value} ") config.meta.doc}

     

       195
       173
        
       

     

       196
       174
        
             xmllint --xinclude --output ./manual-combined.xml ./manual.xml

     

       197
       175
        
       

     
···

       220
       198
        
           '';

     

       221
       199
        
       

     

       222
       200
        
       in rec {

     

       223
       223
       -
         inherit generatedSources;

     

       224
       224
       -
       

     

       225
       201
        
         inherit (optionsDoc) optionsJSON optionsNix optionsDocBook optionsUsedDocbook;

     

       226
       202
        
       

     

       227
       203
        
         # Generate the NixOS manual.

     

       228
       204
        
         manualHTML = runCommand "nixos-manual-html"

     

       229
       229
       -
           { inherit sources;

     

       230
       230
       -
             nativeBuildInputs = [ buildPackages.libxml2.bin buildPackages.libxslt.bin ];

     

       205
       205
       +
           { nativeBuildInputs = [ buildPackages.libxml2.bin buildPackages.libxslt.bin ];

     

       231
       206
        
             meta.description = "The NixOS manual in HTML format";

     

       232
       207
        
             allowedReferences = ["out"];

     

       233
       208
        
           }

     
···

       264
       239
        
         manualHTMLIndex = "${manualHTML}/share/doc/nixos/index.html";

     

       265
       240
        
       

     

       266
       241
        
         manualEpub = runCommand "nixos-manual-epub"

     

       267
       267
       -
           { inherit sources;

     

       268
       268
       -
             nativeBuildInputs = [ buildPackages.libxml2.bin buildPackages.libxslt.bin buildPackages.zip ];

     

       242
       242
       +
           { nativeBuildInputs = [ buildPackages.libxml2.bin buildPackages.libxslt.bin buildPackages.zip ];

     

       269
       243
        
           }

     

       270
       244
        
           ''

     

       271
       245
        
             # Generate the epub manual.

-1

nixos/release.nix

···

       144
       144
        
         manual = manualHTML; # TODO(@oxij): remove eventually

     

       145
       145
        
         manualEpub = (buildFromConfig ({ ... }: { }) (config: config.system.build.manual.manualEpub));

     

       146
       146
        
         manpages = buildFromConfig ({ ... }: { }) (config: config.system.build.manual.manpages);

     

       147
       147
       -
         manualGeneratedSources = buildFromConfig ({ ... }: { }) (config: config.system.build.manual.generatedSources);

     

       148
       147
        
         options = (buildFromConfig ({ ... }: { }) (config: config.system.build.manual.optionsJSON)).x86_64-linux;

     

       149
       148
        
       

     

       150
       149