nixpkgs/pkgs/development/tools/hotdoc/default.nix
2023-11-02 10:09:26 -04:00

127 lines
2.8 KiB
Nix

{ lib
, stdenv
, buildPythonApplication
, fetchpatch
, fetchPypi
, pytestCheckHook
, pkg-config
, cmake
, flex
, glib
, json-glib
, libxml2
, appdirs
, dbus-deviation
, faust-cchardet
, feedgen
, lxml
, networkx
, pkgconfig
, pyyaml
, schema
, setuptools
, toposort
, wheezy-template
, llvmPackages
, gst_all_1
}:
buildPythonApplication rec {
pname = "hotdoc";
version = "0.15";
format = "setuptools";
src = fetchPypi {
inherit pname version;
hash = "sha256-sfQ/iBd1Z+YqnaOg8j32rC2iucdiiK3Tff9NfYFnQyc=";
};
patches = [
(fetchpatch {
name = "fix-test-hotdoc.patch";
url = "https://github.com/hotdoc/hotdoc/commit/d2415a520e960a7b540742a0695b699be9189540.patch";
hash = "sha256-9ORZ91c+/oRqEp2EKXjKkz7u8mLnWCq3uPsc3G4NB9E=";
})
];
nativeBuildInputs = [
pkg-config
cmake
flex
];
buildInputs = [
glib
json-glib
libxml2.dev
];
propagatedBuildInputs = [
appdirs
dbus-deviation
faust-cchardet
feedgen
lxml
networkx
pkgconfig
pyyaml
schema
setuptools # for pkg_resources
toposort
wheezy-template
];
nativeCheckInputs = [
pytestCheckHook
];
# CMake is used to build CMARK, but the build system is still python
dontUseCmakeConfigure = true;
# Ensure C+GI+GST extensions are built and can be imported
pythonImportsCheck = [
"hotdoc.extensions.c.c_extension"
"hotdoc.extensions.gi.gi_extension"
"hotdoc.extensions.gst.gst_extension"
];
# Run the tests by package instead of current dir
pytestFlagsArray = [ "--pyargs" "hotdoc" ];
disabledTests = [
# Test does not correctly handle path normalization for test comparison
"test_cli_overrides"
] ++ lib.optionals stdenv.isDarwin [
# Test does not correctly handle absolute /home paths on Darwin (even fake ones)
"test_index"
];
# Hardcode libclang paths
postPatch = ''
substituteInPlace hotdoc/extensions/c/c_extension.py \
--replace "shutil.which('llvm-config')" 'True' \
--replace "subprocess.check_output(['llvm-config', '--version']).strip().decode()" '"${llvmPackages.libclang.version}"' \
--replace "subprocess.check_output(['llvm-config', '--prefix']).strip().decode()" '"${llvmPackages.libclang.lib}"' \
--replace "subprocess.check_output(['llvm-config', '--libdir']).strip().decode()" '"${llvmPackages.libclang.lib}/lib"'
'';
# Make pytest run from a temp dir to have it pick up installed package for cmark
preCheck = ''
pushd $TMPDIR
'';
postCheck = ''
popd
'';
passthru.tests = {
inherit (gst_all_1) gstreamer gst-plugins-base;
};
meta = with lib; {
description = "The tastiest API documentation system";
homepage = "https://hotdoc.github.io/";
license = [ licenses.lgpl21Plus ];
maintainers = with maintainers; [ lilyinstarlight ];
};
}