nixpkgs/pkgs/development/tools/documentation/mkdocs/default.nix

53 lines
1.3 KiB
Nix
Raw Normal View History

2020-02-12 10:21:40 +00:00
{ stdenv, lib, python3, fetchFromGitHub }:
2017-09-26 12:35:17 +00:00
2020-02-12 10:21:40 +00:00
with python3.pkgs;
2017-09-26 12:35:17 +00:00
buildPythonApplication rec {
pname = "mkdocs";
2018-12-14 23:48:32 +00:00
version = "1.0.4";
2017-09-26 12:35:17 +00:00
2017-10-01 09:56:05 +00:00
src = fetchFromGitHub {
owner = "mkdocs";
repo = "mkdocs";
rev = version;
2018-12-14 23:48:32 +00:00
sha256 = "1x35vgiskgz4wwrvi4m1mri5wlphf15p90fr3rxsy5bf19v3s9hs";
2017-09-26 12:35:17 +00:00
};
2017-10-01 09:56:05 +00:00
checkInputs = [
nose nose-exclude mock
];
2018-12-14 23:48:32 +00:00
NOSE_EXCLUDE_TESTS = lib.concatStringsSep ";" [
"mkdocs.tests.gh_deploy_tests.TestGitHubDeploy"
"mkdocs.tests.config.config_tests.ConfigTests"
"mkdocs.tests.config.config_options_tests.DirTest"
];
2017-10-01 09:56:05 +00:00
checkPhase = "nosetests mkdocs";
2017-09-26 12:35:17 +00:00
propagatedBuildInputs = [
tornado
livereload
click
pyyaml
markdown
jinja2
2018-12-14 23:48:32 +00:00
backports_tempfile
2017-09-26 12:35:17 +00:00
];
meta = with stdenv.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/";
2017-09-26 12:35:17 +00:00
license = lib.licenses.bsd2;
platforms = platforms.unix;
maintainers = [ maintainers.rkoe ];
2017-09-26 12:35:17 +00:00
};
}