nixpkgs/pkgs/development/python-modules/mkdocs/default.nix
2023-09-27 15:33:46 +02:00

90 lines
1.7 KiB
Nix

{
# eval time deps
lib
, buildPythonPackage
, fetchFromGitHub
, pythonOlder
# buildtime
, hatchling
# runtime deps
, click
, ghp-import
, importlib-metadata
, jinja2
, markdown
, markupsafe
, mergedeep
, packaging
, pathspec
, platformdirs
, pyyaml
, pyyaml-env-tag
, watchdog
# testing deps
, babel
, mock
, unittestCheckHook
}:
buildPythonPackage rec {
pname = "mkdocs";
version = "1.5.2";
format = "pyproject";
disabled = pythonOlder "3.6";
src = fetchFromGitHub {
owner = pname;
repo = pname;
rev = "refs/tags/${version}";
hash = "sha256-9sV1bewsHVJEc2kTyGxDM6SjDTEKEc/HSY6gWBC5tvE=";
};
nativeBuildInputs = [
hatchling
];
propagatedBuildInputs = [
click
ghp-import
jinja2
markdown
markupsafe
mergedeep
packaging
pathspec
platformdirs
pyyaml
pyyaml-env-tag
watchdog
] ++ lib.optionals (pythonOlder "3.10") [
importlib-metadata
];
nativeCheckInputs = [
unittestCheckHook
babel
mock
];
unittestFlagsArray = [ "-v" "-p" "'*tests.py'" "mkdocs" ];
pythonImportsCheck = [ "mkdocs" ];
meta = with lib; {
description = "Project documentation with Markdown / static website generator";
longDescription = ''
MkDocs is a fast, simple and downright gorgeous static site generator that's
geared towards building project documentation. Documentation source files
are written in Markdown, and configured with a single YAML configuration file.
MkDocs can also be used to generate general-purpose websites.
'';
homepage = "http://mkdocs.org/";
license = licenses.bsd2;
platforms = platforms.unix;
maintainers = with maintainers; [ rkoe ];
};
}