tjh.dev
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 postPatch = ''
38 substituteInPlace docs/conf.py --replace-fail "sphinx-prompt" "sphinx_prompt"
39 '';
40
41 nativeBuildInputs = [
42 flit-core
43
44 sphinxHook
45 sphinx-notfound-page
46 sphinx-prompt
47 sphinx-rtd-theme
48 sphinx-tabs
49 sphinx-version-warning
50 sphinx-autoapi
51 sphinxcontrib-bibtex
52 sphinxemoji
53 ];
54
55 propagatedBuildInputs = [
56 sphinx
57 sphinxcontrib-jquery
58 ];
59
60 pythonImportsCheck = [ "hoverxref" ];
61
62 meta = with lib; {
63 description = "Sphinx extension for creating tooltips on the cross references of the documentation";
64 longDescription = ''
65 sphinx-hoverxref is a Sphinx extension to show a floating window
66 (tooltips or modal dialogues) on the cross references of the
67 documentation embedding the content of the linked section on them.
68
69 With sphinx-hoverxref, you don’t need to click a link to see what’s
70 in there.
71 '';
72 homepage = "https://github.com/readthedocs/sphinx-hoverxref";
73 license = licenses.mit;
74 maintainers = with maintainers; [ kaction ];
75 };
76}