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