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>
This commit is contained in:
Florian Klink 2024-03-01 10:56:17 +02:00 committed by clbot
parent 6bdaebcb55
commit 65a810fc0b
14 changed files with 45 additions and 116 deletions

View file

@ -1,47 +1,23 @@
{ pkgs, lib, ... }:
let
tl = pkgs.texlive.combine {
inherit (pkgs.texlive) scheme-medium wrapfig ulem capt-of
titlesec preprint enumitem paralist ctex environ svg
beamer trimspaces zhnumber changepage framed pdfpages
fvextra minted upquote ifplatform xstring;
};
csl = pkgs.fetchurl {
name = "numeric.csl";
url = "https://gist.githubusercontent.com/bwiernik/8c6f39cf51ceb3a03107/raw/1d75c2d62113ffbba6ed03a47ad99bde86934f2b/APA%2520Numeric";
sha256 = "1yfhhnhbzvhrv93baz98frmgsx5y442nzhb0l956l4j35fb0cc3h";
};
in
pkgs.stdenv.mkDerivation {
pname = "tvix-doc";
pname = "tvix-docs";
version = "0.1";
outputs = [ "out" "svg" ];
outputs = [ "out" ];
src = lib.cleanSource ./.;
CSL = csl;
nativeBuildInputs = [
pkgs.pandoc
pkgs.mdbook
pkgs.mdbook-plantuml
pkgs.plantuml
tl
];
installPhase = ''
runHook preInstall
mkdir -p $out
cp -v *.html $out/
mkdir -p $svg
cp -v *.svg $svg/
runHook postSubmit
# 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
'';
}