tvl-depot/users/sterni/htmlman
Vincent Ambo aa122cbae7 style: format entire depot with nixpkgs-fmt
This CL can be used to compare the style of nixpkgs-fmt against other
formatters (nixpkgs, alejandra).

Change-Id: I87c6abff6bcb546b02ead15ad0405f81e01b6d9e
Reviewed-on: https://cl.tvl.fyi/c/depot/+/4397
Tested-by: BuildkiteCI
Reviewed-by: sterni <sternenseemann@systemli.org>
Reviewed-by: lukegb <lukegb@tvl.fyi>
Reviewed-by: wpcarro <wpcarro@gmail.com>
Reviewed-by: Profpatsch <mail@profpatsch.de>
Reviewed-by: kanepyork <rikingcoding@gmail.com>
Reviewed-by: tazjin <tazjin@tvl.su>
Reviewed-by: cynthia <cynthia@tvl.fyi>
Reviewed-by: edef <edef@edef.eu>
Reviewed-by: eta <tvl@eta.st>
Reviewed-by: grfn <grfn@gws.fyi>
2022-01-31 16:11:53 +00:00
..
default.nix style: format entire depot with nixpkgs-fmt 2022-01-31 16:11:53 +00:00
defaultStyle.nix feat(users/sterni/htmlman): static site generator for manual pages 2021-03-11 13:12:31 +00:00
README.md feat(users/sterni/htmlman): static site generator for manual pages 2021-03-11 13:12:31 +00:00

htmlman

static site generator for man pages intended for rendering man page documentation viewable using a web browser.

usage

If you have a nix expression, doc.nix, like this:

{ depot, ... }:

depot.users.sterni.htmlman {
  title = "foo project";
  pages = [
    {
      name = "foo";
      section = 1;
    }
    {
      name = "foo";
      section = 3;
      path = ../devman/foo.3;
    }
  ];
  manDir = ../man;
}

You can run the following to directly deploy the resulting documentation output to a specific target directory:

nix-build -A deploy doc.nix && ./result target_directory