mdebray/tvl-depot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
tvl-depot/tvix/docs/default.nix

27 lines
491 B
Nix
Raw Permalink Normal View History

chore(tvix): Add doc build infrastructure Change-Id: I2cf67df085d0c008b5ff5efff2235a670207024a Reviewed-on: https://cl.tvl.fyi/c/depot/+/2711 Tested-by: BuildkiteCI Reviewed-by: flokli <flokli@flokli.de> Reviewed-by: tazjin <mail@tazj.in>
2021-03-31 20:49:09 +02:00
{ pkgs, lib, ... }:
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-30 17:06:58 +01:00
pkgs.stdenv.mkDerivation {
feat(tvix/docs): switch to mdbook Some of the docs are still outdated (like architecture and drv path inconsistencies). Change-Id: I7a6afceb008ef4cd19a764dd6c637b39fa842a2e Reviewed-on: https://cl.tvl.fyi/c/depot/+/11072 Autosubmit: flokli <flokli@flokli.de> Tested-by: BuildkiteCI Reviewed-by: edef <edef@edef.eu>
2024-03-01 09:56:17 +01:00
pname = "tvix-docs";
chore(tvix): Add doc build infrastructure Change-Id: I2cf67df085d0c008b5ff5efff2235a670207024a Reviewed-on: https://cl.tvl.fyi/c/depot/+/2711 Tested-by: BuildkiteCI Reviewed-by: flokli <flokli@flokli.de> Reviewed-by: tazjin <mail@tazj.in>
2021-03-31 20:49:09 +02:00
version = "0.1";
feat(tvix/docs): switch to mdbook Some of the docs are still outdated (like architecture and drv path inconsistencies). Change-Id: I7a6afceb008ef4cd19a764dd6c637b39fa842a2e Reviewed-on: https://cl.tvl.fyi/c/depot/+/11072 Autosubmit: flokli <flokli@flokli.de> Tested-by: BuildkiteCI Reviewed-by: edef <edef@edef.eu>
2024-03-01 09:56:17 +01:00
outputs = [ "out" ];
chore(tvix): Make docs multi output We also want to access the produced SVGs separately. Change-Id: I5bdfd95b8a56323ed8bf5f4585b703f6e728c677 Reviewed-on: https://cl.tvl.fyi/c/depot/+/2742 Tested-by: BuildkiteCI Reviewed-by: tazjin <mail@tazj.in>
2021-04-01 00:35:04 +02:00
chore(tvix): Add doc build infrastructure Change-Id: I2cf67df085d0c008b5ff5efff2235a670207024a Reviewed-on: https://cl.tvl.fyi/c/depot/+/2711 Tested-by: BuildkiteCI Reviewed-by: flokli <flokli@flokli.de> Reviewed-by: tazjin <mail@tazj.in>
2021-03-31 20:49:09 +02:00
src = lib.cleanSource ./.;
nativeBuildInputs = [
feat(tvix/docs): add d2 support This provides a nicer syntax to draw some diagrams. Change-Id: I2ab580e61399a45f01ed422ee29382e860753ffa Reviewed-on: https://cl.tvl.fyi/c/depot/+/11807 Autosubmit: flokli <flokli@flokli.de> Tested-by: BuildkiteCI Reviewed-by: yuka <yuka@yuka.dev>
2024-06-13 20:57:53 +02:00
pkgs.d2
feat(tvix/docs): switch to mdbook Some of the docs are still outdated (like architecture and drv path inconsistencies). Change-Id: I7a6afceb008ef4cd19a764dd6c637b39fa842a2e Reviewed-on: https://cl.tvl.fyi/c/depot/+/11072 Autosubmit: flokli <flokli@flokli.de> Tested-by: BuildkiteCI Reviewed-by: edef <edef@edef.eu>
2024-03-01 09:56:17 +01:00
pkgs.mdbook
feat(tvix/docs): add mdbook-admonish This provides a plugin for callouts. It needs to have additional CSS file added to `book.toml`, which can be (re-)generated by `mdbook-admonish install`. See https://github.com/tommilligan/mdbook-admonish/issues/171#issuecomment-2009166079 for more context. Use it by adding a warning one to the architecture document. Change-Id: I75c9a33d00acb603c6da10d3f9ce3485731c1672 Reviewed-on: https://cl.tvl.fyi/c/depot/+/11805 Tested-by: BuildkiteCI Autosubmit: flokli <flokli@flokli.de> Reviewed-by: yuka <yuka@yuka.dev>
2024-06-13 20:37:16 +02:00
pkgs.mdbook-admonish
feat(tvix/docs): add d2 support This provides a nicer syntax to draw some diagrams. Change-Id: I2ab580e61399a45f01ed422ee29382e860753ffa Reviewed-on: https://cl.tvl.fyi/c/depot/+/11807 Autosubmit: flokli <flokli@flokli.de> Tested-by: BuildkiteCI Reviewed-by: yuka <yuka@yuka.dev>
2024-06-13 20:57:53 +02:00
pkgs.mdbook-d2
feat(tvix/docs): switch to mdbook Some of the docs are still outdated (like architecture and drv path inconsistencies). Change-Id: I7a6afceb008ef4cd19a764dd6c637b39fa842a2e Reviewed-on: https://cl.tvl.fyi/c/depot/+/11072 Autosubmit: flokli <flokli@flokli.de> Tested-by: BuildkiteCI Reviewed-by: edef <edef@edef.eu>
2024-03-01 09:56:17 +01:00
pkgs.mdbook-plantuml
chore(tvix): Add doc build infrastructure Change-Id: I2cf67df085d0c008b5ff5efff2235a670207024a Reviewed-on: https://cl.tvl.fyi/c/depot/+/2711 Tested-by: BuildkiteCI Reviewed-by: flokli <flokli@flokli.de> Reviewed-by: tazjin <mail@tazj.in>
2021-03-31 20:49:09 +02:00
pkgs.plantuml
];
feat(tvix/docs): switch to mdbook Some of the docs are still outdated (like architecture and drv path inconsistencies). Change-Id: I7a6afceb008ef4cd19a764dd6c637b39fa842a2e Reviewed-on: https://cl.tvl.fyi/c/depot/+/11072 Autosubmit: flokli <flokli@flokli.de> Tested-by: BuildkiteCI Reviewed-by: edef <edef@edef.eu>
2024-03-01 09:56:17 +01:00
# plantuml wants to create ./.mdbook-plantuml-cache, which fails as $src is r/o.
# copy all sources elsewhere to workaround.
buildCommand = ''
cp -R $src/. .
mdbook build -d $out
chore(tvix): Add doc build infrastructure Change-Id: I2cf67df085d0c008b5ff5efff2235a670207024a Reviewed-on: https://cl.tvl.fyi/c/depot/+/2711 Tested-by: BuildkiteCI Reviewed-by: flokli <flokli@flokli.de> Reviewed-by: tazjin <mail@tazj.in>
2021-03-31 20:49:09 +02:00
'';
}
Reference in a new issue Copy permalink