pkgs/development/python-modules/sphinx-better-theme/default.nix

   1 { lib, buildPythonPackage, fetchFromGitHub, sphinxHook }:
   2
   3 buildPythonPackage rec {
   4   pname = "sphinx-better-theme";
   5   version = "0.1.5";
   6   format = "setuptools";
   7   outputs = [ "out" "doc" ];
   8
   9   src = fetchFromGitHub {
  10     owner = "irskep";
  11     repo = "sphinx-better-theme";
  12     rev = "v${version}";
  13     sha256 = "07lhfmsjcfzcchsjzh6kxdq5s47j2a6lb5wv3m1kmv2hcm3gvddh";
  14   };
  15
  16   nativeBuildInputs = [ sphinxHook ];
  17
  18   pythonImportsCheck = [ "better" ];
  19
  20   meta = with lib; {
  21     homepage = "https://github.com/irskep/sphinx-better-theme";
  22     description = "Better Sphinx Theme";
  23     longDescription = ''
  24       This is a modified version of the default Sphinx theme with the following
  25       goals:
  26
  27       1. Remove frivolous colors, especially hard-coded ones
  28       2. Improve readability by limiting width and using more whitespace
  29       3. Encourage visual customization through CSS, not themeconf
  30       4. Use semantic markup
  31
  32       v0.1 meets goals one and two. Goal three is partially complete; it's simple to
  33       add your own CSS file without creating a whole new theme.
  34       you'd like something changed.
  35
  36       To use the theme, set ``html_theme_path`` to contain
  37       ``better.better_theme_path``, and set ``html_theme`` to ``'better'``::
  38
  39           from better import better_theme_path
  40           html_theme_path = [better_theme_path]
  41           html_theme = 'better'
  42     '';
  43     license = licenses.bsd2;
  44     maintainers = with maintainers; [ kaction ];
  45   };
  46 }