pkgs/development/python-modules/mkdocs-gitlab-plugin/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

{ buildPythonPackage
, fetchzip
, isPy3k
, lib
, mkdocs
}:

buildPythonPackage rec {
  pname = "mkdocs-gitlab-plugin";
  version = "0.1.4";
  format = "setuptools";

  disabled = !isPy3k;

  src = fetchzip {
    url = "https://gitlab.inria.fr/vidjil/mkdocs-gitlab-plugin/-/archive/fb87fbfd404839e661a799c540664b1103096a5f/mkdocs-gitlab-plugin-fb87fbfd404839e661a799c540664b1103096a5f.tar.gz";
    hash = "sha256-z+U0PRwymDDXVNM7a2Yl4pNNVBxpx/BhJnlx6kgyvww=";
  };

  patches = [ ./mkdocs-gitlab-plugin.diff ];

  propagatedBuildInputs = [ mkdocs ];

  pythonImportsCheck = [ "mkdocs_gitlab_plugin" ];

  meta = with lib; {
    description = "MkDocs plugin to transform strings such as #1234, %56, or !789 into links to a Gitlab repository.";
    homepage = "https://gitlab.inria.fr/vidjil/mkdocs-gitlab-plugin";
    license = licenses.mit;
    maintainers = with maintainers; [ snpschaaf ];
    longDescription = ''
      Plugin for MkDocs.
      Transform handles such as #1234, %56, !789, &12 or $34 into links to a gitlab repository,
      given by the gitlab_url configuration option.
      Before the #/%/!/&/$ is needed either a space, a '(', or a '['.
    '';
  };
}