summary refs log tree commit diff
path: root/pkgs/os-specific/linux/kernel/htmldocs.nix
blob: 4e42288aff8d52341ad0ace9822c9eccb466b224 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
{ lib
, stdenv
, graphviz
, imagemagick
, linux_latest
, makeFontsConf
, perl
, python3
, sphinx
, which
}:

let
  py = python3.override {
    packageOverrides = final: prev: rec {
      docutils_old = prev.docutils.overridePythonAttrs (oldAttrs: rec {
        version = "0.16";
        src = final.fetchPypi {
          pname = "docutils";
          inherit version;
          sha256 = "sha256-wt46YOnn0Hvia38rAMoDCcIH4GwQD5zCqUkx/HWkePw=";
        };
      });

      sphinx = (prev.sphinx.override rec {
        alabaster = prev.alabaster.override { inherit pygments; };
        docutils = docutils_old;
        pygments = prev.pygments.override { docutils = docutils_old; };
      }).overridePythonAttrs {
        # fails due to duplicated packages
        doCheck = false;
      };

      sphinx-rtd-theme = prev.sphinx-rtd-theme.override {
        inherit sphinx;
        docutils = docutils_old;
      };
    };
  };
in

stdenv.mkDerivation {
  pname = "linux-kernel-latest-htmldocs";

  inherit (linux_latest) version src;

  postPatch = ''
    patchShebangs \
      Documentation/sphinx/parse-headers.pl \
      scripts/{get_abi.pl,get_feat.pl,kernel-doc,sphinx-pre-install}
  '';

  FONTCONFIG_FILE = makeFontsConf {
    fontDirectories = [ ];
  };

  nativeBuildInputs = [
    graphviz
    imagemagick
    perl
    py.pkgs.sphinx
    py.pkgs.sphinx-rtd-theme
    which
  ];

  preBuild = ''
    export XDG_CACHE_HOME="$(mktemp -d)"
  '';

  makeFlags = [ "htmldocs" ];

  installPhase = ''
    mkdir -p $out/share/doc
    mv Documentation/output $out/share/doc/linux-doc
    cp -r Documentation/* $out/share/doc/linux-doc/
  '';

  meta = with lib; {
    description = "Linux kernel html documentation";
    homepage = "https://www.kernel.org/doc/htmldocs/";
    platforms = platforms.linux;
    inherit (linux_latest.meta) license;
    maintainers = with maintainers; [ SuperSandro2000 ];
  };
}