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