pkgs/development/python-modules/sphinx-hoverxref/default.nix

   1 { lib
   2 , buildPythonPackage
   3 , fetchFromGitHub
   4 , flit-core
   5 , pythonImportsCheckHook
   6 # documentation build dependencies
   7 , sphinxHook
   8 , sphinx-notfound-page
   9 , sphinx-prompt
  10 , sphinx-rtd-theme
  11 , sphinx-tabs
  12 , sphinx-version-warning
  13 , sphinx-autoapi
  14 , sphinxcontrib-bibtex
  15 , sphinxemoji
  16 # runtime dependencies
  17 , sphinx
  18 , sphinxcontrib-jquery
  19 }:
  20
  21 buildPythonPackage rec {
  22   pname = "sphinx-hoverxref";
  23   version = "1.3.0";
  24   format = "pyproject";
  25   outputs = [ "out" "doc" ];
  26
  27   src = fetchFromGitHub {
  28     owner = "readthedocs";
  29     repo = "sphinx-hoverxref";
  30     rev = version;
  31     hash = "sha256-DJ+mHu9IeEYEyf/SD+nDNtWpTf6z7tQzG0ogaECDpkU=";
  32   };
  33
  34   nativeBuildInputs = [
  35     flit-core
  36     pythonImportsCheckHook
  37
  38     sphinxHook
  39     sphinx-notfound-page
  40     sphinx-prompt
  41     sphinx-rtd-theme
  42     sphinx-tabs
  43     sphinx-version-warning
  44     sphinx-autoapi
  45     sphinxcontrib-bibtex
  46     sphinxemoji
  47   ];
  48
  49   propagatedBuildInputs = [ sphinx sphinxcontrib-jquery ];
  50
  51   pythonImportsCheck = [ "hoverxref" ];
  52
  53   meta = with lib; {
  54     description = "A sphinx extension for creating tooltips on the cross references of the documentation";
  55     longDescription = ''
  56       sphinx-hoverxref is a Sphinx extension to show a floating window
  57       (tooltips or modal dialogues) on the cross references of the
  58       documentation embedding the content of the linked section on them.
  59
  60       With sphinx-hoverxref, you don’t need to click a link to see what’s
  61       in there.
  62     '';
  63     homepage = "https://github.com/readthedocs/sphinx-hoverxref";
  64     license = licenses.mit;
  65     maintainers = with maintainers; [ kaction ];
  66   };
  67 }