pkgs/development/tools/documentation/mkdocs/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
49
50
51
52

{ stdenv, lib, python, fetchFromGitHub }:

with python.pkgs;

buildPythonApplication rec {
  pname = "mkdocs";
  version = "1.0.4";

  src = fetchFromGitHub {
    owner = "mkdocs";
    repo = "mkdocs";
    rev = version;
    sha256 = "1x35vgiskgz4wwrvi4m1mri5wlphf15p90fr3rxsy5bf19v3s9hs";
  };

  checkInputs = [
    nose nose-exclude mock
  ];

  NOSE_EXCLUDE_TESTS = lib.concatStringsSep ";" [
    "mkdocs.tests.gh_deploy_tests.TestGitHubDeploy"
    "mkdocs.tests.config.config_tests.ConfigTests"
    "mkdocs.tests.config.config_options_tests.DirTest"
  ];

  checkPhase = "nosetests mkdocs";

  propagatedBuildInputs = [
    tornado
    livereload
    click
    pyyaml
    markdown
    jinja2
    backports_tempfile
  ];

  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/;
    license = lib.licenses.bsd2;
    platforms = platforms.unix;
    maintainers = [ maintainers.rkoe ];
  };
}