add nixos options docs

This commit is contained in:
Tassilo - 2022-09-04 15:06:02 +02:00
parent ebc0b3be6c
commit 4619b92fe0
Signed by: revol-xut
GPG Key ID: 4F56FF7759627D07
3 changed files with 41 additions and 33 deletions

View File

@ -41,7 +41,7 @@
dump-dvb.overlays.default
(final: pref: {
options-docs = (pkgs.nixosOptionsDoc {
options = self.nixosConfigurations.data-hoarder.options;
options = self.nixosConfigurations.data-hoarder.options.dump-dvb;
}).optionsCommonMark;
})
];
@ -146,6 +146,11 @@
mobile-box-disk = self.nixosConfigurations.mobile-box.config.system.build.diskImage;
staging-microvm = self.nixosConfigurations.staging-data-hoarder.config.microvm.declaredRunner;
data-hoarder-microvm = self.nixosConfigurations.data-hoarder.config.microvm.declaredRunner;
docs = pkgs.callPackage ./pkgs/documentation.nix {
options-docs = (pkgs.nixosOptionsDoc {
options = self.nixosConfigurations.data-hoarder.options.dump-dvb;
}).optionsCommonMark;
};
} // (import ./pkgs/deployment.nix { inherit self pkgs; systems = stop_boxes; });
in
{

View File

@ -1,37 +1,6 @@
{ pkgs, config, lib, ... }:
let
documentation-package = pkgs.stdenv.mkDerivation {
pname = "dvb-dump-docs";
version = "0.1.0";
src = pkgs.fetchFromGitHub {
owner = "dump-dvb";
repo = "documentation";
rev = "4c6a265ef894a57da94b753e7e5464c143ed2a53"; #TODO: use tag
sha256 = "sha256-5JV2JYS2QEyB0cewIOLl7iqpcagyCP/expnExyi5E/Q=";
};
nativeBuildInputs = with pkgs; [ mdbook mdbook-mermaid ];
patchPhase = ''
cp ${pkgs.options-docs} src/chapter_2_3_nixos_options.md
'';
buildPhase = ''
${pkgs.mdbook-mermaid}/bin/mdbook-mermaid install
${pkgs.mdbook}/bin/mdbook build
'';
installPhase = ''
mkdir -p $out/bin/
cp -r book/* $out/bin/
'';
meta = with lib; {
description = "Documentation for DVB-Dump project";
homepage = "https://github.com/dump-dvb/documentation";
};
};
documentation-package = pkgs.callPackage ../../pkgs/documentation.nix { };
in {
services = {
nginx = {

34
pkgs/documentation.nix Normal file
View File

@ -0,0 +1,34 @@
{pkgs, lib, stdenv, mdbook-mermaid, mdbook, options-docs, fetchFromGitHub}:
stdenv.mkDerivation {
pname = "dvb-dump-docs";
version = "0.1.0";
src = pkgs.fetchFromGitHub {
owner = "dump-dvb";
repo = "documentation";
rev = "2161bae8e9d423c5e963b87d585d2a11c9e2827b"; #TODO: use tag
sha256 = "sha256-8YnV8PVU/fnHwszhLrlppI/PXCrq6EoYcl45dlOZVvE=";
};
nativeBuildInputs = [ mdbook mdbook-mermaid ];
patchPhase = ''
cp ${options-docs} src/chapter_2_3_nixos_options.md
ls -alh src/
'';
buildPhase = ''
${mdbook-mermaid}/bin/mdbook-mermaid install
${mdbook}/bin/mdbook build
'';
installPhase = ''
mkdir -p $out/bin/
cp -r book/* $out/bin/
'';
meta = with lib; {
description = "Documentation for DVB-Dump project";
homepage = "https://github.com/dump-dvb/documentation";
};
}