doc: nix package to run sphinx with sanity

- official release of javasphinx in PyPI is broken with recent sphinx.
  fork on github.com/simgrid/javasphinx is used instead
- other sphinx deps not in nixpkgs are packaged in default.nix

diff --git a/docs/default.nix b/docs/default.nix
new file mode 100644 (file)
index 0000000..7ba4219
--- /dev/null
+++ b/docs/default.nix
@@ -0,0 +1,88 @@
+# Nix package for SimGrid's sphinx documentation.
+# Example usage: nix-build ./default.nix -A simgrid-doc && firefox result/index.html
+{ pkgs ? import (fetchTarball {
+    url = "https://github.com/NixOS/nixpkgs/archive/21.05.tar.gz";
+    sha256 = "1ckzhh24mgz6jd1xhfgx0i9mijk6xjqxwsshnvq789xsavrmsc36";
+  }) {}
+}:
+
+let
+  pythonPackages = pkgs.python3Packages;
+  buildPythonPackage = pythonPackages.buildPythonPackage;
+
+  self = rec {
+    # the desired package
+    simgrid-doc = pkgs.stdenv.mkDerivation rec {
+      name = "simgrid-doc";
+      src = ./..;
+      buildInputs = [
+        pkgs.doxygen
+        pythonPackages.sphinx
+        pythonPackages.sphinx_rtd_theme
+        pythonPackages.breathe
+        javasphinx
+        sphinx-tabs
+      ];
+      phases = [ "unpackPhase" "buildPhase" "installPhase" ];
+      buildPhase = ''
+        cd docs
+        rm -rf build # this is not done in your directory, this is on the copy made by the Nix build daemon
+        sphinx-build -b html source build
+      '';
+      installPhase = ''
+        mkdir -p $out
+        mv build/* $out/
+      '';
+    };
+
+    # sphinx extensions (and their dependencies) shenanigans
+    javalang = buildPythonPackage rec {
+      pname = "javalang";
+      version = "0.13.0";
+      src = pythonPackages.fetchPypi {
+        inherit pname version;
+        sha256 = "0k22ldm4xn0sb26qclp5zz0fc9dy589zvvby5ba1d0d5h2jab08n";
+      };
+      buildInputs = with pythonPackages; [ six ];
+      doCheck = false;
+    };
+
+    javasphinx = buildPythonPackage rec {
+      pname = "javasphinx";
+      version = "0.9.15+simgrid";
+      src = pkgs.fetchFromGitHub {
+        owner = "simgrid";
+        repo = pname;
+        rev = "659209069603a5f221596dd039e724cb89b31b82";
+        sha256 = "1nbz822zd2ikzzmpyqsrrpqvlpng72qvl86wcqfn89szbp85c20a";
+      };
+      propagatedBuildInputs = with pythonPackages; [
+        beautifulsoup4
+        docutils
+        javalang
+        future
+        lxml
+        sphinx
+      ];
+    };
+
+    sphinx-tabs = pythonPackages.buildPythonPackage rec {
+      pname = "sphinx-tabs";
+      version = "3.1.0";
+      name = "${pname}-${version}";
+
+      src = pythonPackages.fetchPypi {
+        inherit pname version;
+        sha256 = "0kv935qhml40mly33rk5am128g2ygqkfvizh33vf29hjkf32mvjy";
+      };
+
+      propagatedBuildInputs = with pythonPackages; [
+        docutils
+        pygments
+        sphinx
+      ];
+    };
+
+  };
+in
+  self