diff --git a/docs/man-pages.xml b/docs/man-pages.xml new file mode 100644 index 0000000..6c01f36 --- /dev/null +++ b/docs/man-pages.xml @@ -0,0 +1,38 @@ + + + Self Host Blocks Reference Pages + + Self Host Blocks contributors + + 2022Self Host Blocks contributors + + + + + selfhostblocks-options + 5 + Self Host Blocks + + + selfhostblocks-options + Self Host Blocks configuration specification + + + Description + + This contains the module options available for Self Host Blocks. + + + + Options + + You can use the following options in selfhostblocks.nix or in the + modules argument of lib.nixOnDroidConfiguration + in your flake.nix: + + + + + diff --git a/docs/manual.xml b/docs/manual.xml index 7057dbc..238eb48 100644 --- a/docs/manual.xml +++ b/docs/manual.xml @@ -1,13 +1,59 @@ + - - A simple example - - - A simple example - Hello, world! - + xml:id="book-manual"> + + Self Host Blocks manual + + + Preface + + Some basic documentation of Self Host Blocks. + + + If you encounter problems or bugs then please report them on the + issue tracker. + + + + + Self Host Blocks configuration options +
+ Usage + + + To use these options, edit the config file in + ~/.config/nixpkgs/selfhostblocks.nix or in case of a flake setup, + set the modules value in the nixOnDroidConfiguration + call: + +{ + inputs = { + nixpkgs.url = "github:NixOS/nixpkgs/nixos-23.05"; + + nix-on-droid = { + url = "github:nix-community/nix-on-droid/release-23.05"; + inputs.nixpkgs.follows = "nixpkgs"; + }; + }; + + outputs = { self, nixpkgs, nix-on-droid }: { + + nixOnDroidConfigurations.deviceName = nix-on-droid.lib.nixOnDroidConfiguration { + modules = [ ./nix-on-droid.nix ]; + }; + + }; +} + + +
+
+ Options + + +
+
diff --git a/flake.lock b/flake.lock index ecb8910..66e4a93 100644 --- a/flake.lock +++ b/flake.lock @@ -82,24 +82,18 @@ } }, "nmd": { - "inputs": { - "nixpkgs": [ - "nixpkgs" - ], - "scss-reset": "scss-reset" - }, "locked": { - "lastModified": 1687627428, - "narHash": "sha256-7zGfXuNS5RHqhpEdz2fwrtqvF86JRo5U1hrxZSYgcm8=", - "ref": "refs/heads/master", - "rev": "824a380546b5d0d0eb701ff8cd5dbafb360750ff", - "revCount": 63, - "type": "git", - "url": "https://git.sr.ht/~rycee/nmd" + "lastModified": 1672240039, + "narHash": "sha256-lmct89fYDOr9YdWVvdJgklv/7WttRSiDAkoi2cvvAW4=", + "owner": "gvolpe", + "repo": "nmd", + "rev": "a59e840c2e8d54415485f349760e1350cb80d911", + "type": "github" }, "original": { - "type": "git", - "url": "https://git.sr.ht/~rycee/nmd" + "owner": "gvolpe", + "repo": "nmd", + "type": "github" } }, "root": { @@ -111,22 +105,6 @@ "sops-nix": "sops-nix" } }, - "scss-reset": { - "flake": false, - "locked": { - "lastModified": 1631450058, - "narHash": "sha256-muDlZJPtXDIGevSEWkicPP0HQ6VtucbkMNygpGlBEUM=", - "owner": "andreymatin", - "repo": "scss-reset", - "rev": "0cf50e27a4e95e9bb5b1715eedf9c54dee1a5a91", - "type": "github" - }, - "original": { - "owner": "andreymatin", - "repo": "scss-reset", - "type": "github" - } - }, "sops-nix": { "inputs": { "nixpkgs": "nixpkgs_2", diff --git a/flake.nix b/flake.nix index ab0d0c4..7d254b0 100644 --- a/flake.nix +++ b/flake.nix @@ -6,13 +6,15 @@ sops-nix.url = "github:Mic92/sops-nix"; nix-flake-tests.url = "github:antifuchs/nix-flake-tests"; flake-utils.url = "github:numtide/flake-utils"; - nmd.url = "git+https://git.sr.ht/~rycee/nmd"; - nmd.inputs.nixpkgs.follows = "nixpkgs"; + nmd.url = "github:gvolpe/nmd"; }; outputs = { nixpkgs, nix-flake-tests, flake-utils, nmd, ... }: flake-utils.lib.eachDefaultSystem (system: let - pkgs = nixpkgs.legacyPackages.${system}; + pkgs = import nixpkgs { + inherit system; + overlays = [ nmd.overlays.default ]; + }; in { nixosModules.default = { config, ... }: { @@ -40,14 +42,12 @@ # Inspiration from https://github.com/nix-community/nix-on-droid/blob/039379abeee67144d4094d80bbdaf183fb2eabe5/docs/default.nix#L22 packages.manualHtml = let - nmdlib = import nmd { inherit pkgs; }; - setupModule = { - _module.args.pkgs = pkgs.lib.mkForce (nmdlib.scrubDerivations "pkgs" pkgs); + _module.args.pkgs = pkgs.lib.mkForce (pkgs.nmd.scrubDerivations "pkgs" pkgs); _module.check = false; }; - modulesDocs = nmdlib.buildModulesDocs { + modulesDocs = pkgs.nmd.buildModulesDocs { modules = [ setupModule ./modules/blocks/ssl.nix @@ -58,7 +58,7 @@ docBook = { id = "selfhostblocks-options"; optionIdPrefix = "shb-opt"; }; }; - manual = nmdlib.buildDocBookDocs { + manual = pkgs.nmd.buildDocBookDocs { pathName = "SelfHostBlocks"; modulesDocs = [ modulesDocs ]; documentsDirectory = ./docs;