pyrox.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.5.0";
24 pyproject = true;
25
26 outputs = [
27 "out"
28 "doc"
29 ];
30
31 src = fetchFromGitHub {
32 owner = "readthedocs";
33 repo = "sphinx-hoverxref";
34 rev = version;
35 hash = "sha256-JHNJGUkO/HXnnnROYBd1pAcoAEYo6b7eK4tyC+ujc+A=";
36 };
37
38 postPatch = ''
39 substituteInPlace docs/conf.py --replace-fail "sphinx-prompt" "sphinx_prompt"
40 '';
41
42 build-system = [
43 flit-core
44 ];
45
46 nativeBuildInputs = [
47 sphinxHook
48 sphinx-autoapi
49 sphinx-rtd-theme
50 sphinx-tabs
51 sphinx-prompt
52 sphinx-version-warning
53 sphinx-notfound-page
54 sphinxcontrib-bibtex
55 sphinxemoji
56 ];
57
58 dependencies = [
59 sphinx
60 sphinxcontrib-jquery
61 ];
62
63 pythonImportsCheck = [ "hoverxref" ];
64
65 meta = {
66 description = "Sphinx extension for creating tooltips on the cross references of the documentation";
67 longDescription = ''
68 sphinx-hoverxref is a Sphinx extension to show a floating window
69 (tooltips or modal dialogues) on the cross references of the
70 documentation embedding the content of the linked section on them.
71
72 With sphinx-hoverxref, you don’t need to click a link to see what’s
73 in there.
74 '';
75 homepage = "https://github.com/readthedocs/sphinx-hoverxref";
76 license = lib.licenses.mit;
77 maintainers = with lib.maintainers; [ kaction ];
78 };
79}