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


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

{
  lib,
  buildPythonPackage,
  fetchFromGitHub,
  pythonOlder,
  mako,
  markdown,
  setuptools-git,
  setuptools-scm,
  unittestCheckHook,
}:

buildPythonPackage rec {
  pname = "pdoc3";
  version = "0.11.1";
  pyproject = true;
  disabled = pythonOlder "3.9";

  src = fetchFromGitHub {
    owner = "pdoc3";
    repo = "pdoc";
    rev = "refs/tags/${version}";
    hash = "sha256-Opj1fU1eZvqsYJGCBliVwugxFV4H1hzOOTkjs4fOEWA=";
  };

  build-system = [
    setuptools-git
    setuptools-scm
  ];

  dependencies = [
    mako
    markdown
  ];

  pythonImportsCheck = [ "pdoc" ];

  nativeCheckInputs = [ unittestCheckHook ];

  meta = {
    changelog = "https://github.com/pdoc3/pdoc/blob/${src.rev}/CHANGELOG";
    description = "Auto-generate API documentation for Python projects";
    homepage = "https://pdoc3.github.io/pdoc/";
    license = lib.licenses.agpl3Plus;
    mainProgram = "pdoc";
    maintainers = with lib.maintainers; [ catern ];
  };
}