pkgs/development/python-modules/pdoc/default.nix

   1 { lib
   2 , buildPythonPackage
   3 , pythonOlder
   4 , fetchFromGitHub
   5 , setuptools
   6 , jinja2
   7 , pdoc-pyo3-sample-library
   8 , pygments
   9 , markupsafe
  10 , astunparse
  11 , pytestCheckHook
  12 , hypothesis
  13 }:
  14
  15 buildPythonPackage rec {
  16   pname = "pdoc";
  17   version = "14.4.0";
  18   disabled = pythonOlder "3.8";
  19
  20   pyproject = true;
  21
  22   src = fetchFromGitHub {
  23     owner = "mitmproxy";
  24     repo = "pdoc";
  25     rev = "v${version}";
  26     hash = "sha256-2k9uIK6TvoGtVqnh97g9f5QvjhyZlznRvYdw5sPaeVE=";
  27   };
  28
  29   nativeBuildInputs = [
  30     setuptools
  31   ];
  32
  33   propagatedBuildInputs = [
  34     jinja2
  35     pygments
  36     markupsafe
  37   ] ++ lib.optional (pythonOlder "3.9") astunparse;
  38
  39   nativeCheckInputs = [
  40     pytestCheckHook
  41     hypothesis
  42     pdoc-pyo3-sample-library
  43   ];
  44   disabledTestPaths = [
  45     # "test_snapshots" tries to match generated output against stored snapshots,
  46     # which are highly sensitive to dep versions.
  47     "test/test_snapshot.py"
  48   ];
  49
  50   pytestFlagsArray = [
  51     ''-m "not slow"'' # skip slow tests
  52   ];
  53
  54   __darwinAllowLocalNetworking = true;
  55
  56   pythonImportsCheck = [ "pdoc" ];
  57
  58   meta = with lib; {
  59     changelog = "https://github.com/mitmproxy/pdoc/blob/${src.rev}/CHANGELOG.md";
  60     homepage = "https://pdoc.dev/";
  61     description = "API Documentation for Python Projects";
  62     mainProgram = "pdoc";
  63     license = licenses.unlicense;
  64     maintainers = with maintainers; [ pbsds ];
  65   };
  66 }