1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
| | ;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2014 David Thompson <davet@gnu.org>
;;; Copyright © 2015, 2017, 2019, 2020, 2021, 2023, 2024 Ricardo Wurmus <rekado@elephly.net>
;;; Copyright © 2015, 2016, 2017 Leo Famulari <leo@famulari.name>
;;; Copyright © 2016 Hartmut Goebel <h.goebel@crazy-compilers.com>
;;; Copyright © 2016-2019, 2022, 2023 Marius Bakke <marius@gnu.org>
;;; Copyright © 2017 Danny Milosavljevic <dannym+a@scratchpost.org>
;;; Copyright © 2017, 2018, 2020 Tobias Geerinckx-Rice <me@tobias.gr>
;;; Copyright © 2017 Frederick M. Muriithi <fredmanglis@gmail.com>
;;; Copyright © 2017 Christine Lemmer-Webber <cwebber@dustycloud.org>
;;; Copyright © 2017 Julien Lepiller <julien@lepiller.eu>
;;; Copyright © 2019, 2021, 2022 Efraim Flashner <efraim@flashner.co.il>
;;; Copyright © 2019, 2021, 2023 Nicolas Goaziou <mail@nicolasgoaziou.fr>
;;; Copyright © 2019 Alexandros Theodotou <alex@zrythm.org>
;;; Copyright © 2019 Brett Gilio <brettg@gnu.org>
;;; Copyright © 2020 Giacomo Leidi <goodoldpaul@autistici.org>
;;; Copyright © 2021 Eric Bavier <bavier@posteo.net>
;;; Copyright © 2021, 2022, 2024 Vinicius Monego <monego@posteo.net>
;;; Copyright © 2021 Hugo Lecomte <hugo.lecomte@inria.fr>
;;; Copyright © 2021, 2022, 2024 Maxim Cournoyer <maxim.cournoyer@gmail.com>
;;; Copyright © 2024 Troy Figiel <troy@troyfigiel.com>
;;; Copyright © 2021 Maxime Devos <maximedevos@telenet.be>
;;;
;;; This file is part of GNU Guix.
;;;
;;; GNU Guix is free software; you can redistribute it and/or modify it
;;; under the terms of the GNU General Public License as published by
;;; the Free Software Foundation; either version 3 of the License, or (at
;;; your option) any later version.
;;;
;;; GNU Guix is distributed in the hope that it will be useful, but
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;;; GNU General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
(define-module (gnu packages sphinx)
#:use-module (guix packages)
#:use-module (guix download)
#:use-module (guix git-download)
#:use-module (guix hg-download)
#:use-module (guix gexp)
#:use-module (guix utils)
#:use-module (guix build-system python)
#:use-module (guix build-system pyproject)
#:use-module ((guix licenses) #:prefix license:)
#:use-module (gnu packages)
#:use-module (gnu packages certs)
#:use-module (gnu packages check)
#:use-module (gnu packages fonts)
#:use-module (gnu packages fontutils)
#:use-module (gnu packages graphviz)
#:use-module (gnu packages image)
#:use-module (gnu packages imagemagick)
#:use-module (gnu packages jupyter)
#:use-module (gnu packages python)
#:use-module (gnu packages python-build)
#:use-module (gnu packages python-check)
#:use-module (gnu packages python-crypto)
#:use-module (gnu packages python-web)
#:use-module (gnu packages python-xyz)
#:use-module (gnu packages time)
#:use-module (gnu packages python-science)
#:use-module (gnu packages graph)
#:use-module (gnu packages tex))
(define-public python-sphinx
(package
(name "python-sphinx")
(version "6.2.1")
(source
(origin
(method url-fetch)
(uri (pypi-uri "Sphinx" version))
(sha256
(base32
"0sycp5qx7py75fvmjz0av5awfdlqn72azzjj07x9yx5vjx3a6mkd"))))
(build-system pyproject-build-system)
(arguments
(list
#:test-flags
;; These require Internet access.
#~(list "-k" (string-append "not test_latex_images"
" and not test_build_latex_doc[lualatex-manual]"
" and not est_build_latex_doc[lualatex-howto]"))
#:phases
#~(modify-phases %standard-phases
(add-before 'check 'pre-check
(lambda _
;; for test_cython
(setenv "HOME" "/tmp"))))))
(propagated-inputs
(list python-babel
python-colorama
python-docutils
python-filelock
python-html5lib
python-imagesize
python-importlib-metadata
python-jinja2
python-packaging
python-pygments
python-requests
python-snowballstemmer
python-sphinx-alabaster-theme
python-sphinxcontrib-applehelp
python-sphinxcontrib-devhelp
python-sphinxcontrib-htmlhelp
python-sphinxcontrib-jsmath
python-sphinxcontrib-qthelp
python-sphinxcontrib-serializinghtml
python-sphinxcontrib-websupport
python-types-requests
;; The Sphinx LaTeX library '\RequirePackage' or \\usepackage
;; these:
texlive-amsfonts ;amsmath, amssymb, amstext
texlive-amsmath
texlive-anyfontsize
texlive-booktabs
texlive-capt-of
texlive-carlisle ;remreset
texlive-cmap
texlive-etoolbox
texlive-fancyhdr
texlive-fancyvrb
texlive-float
texlive-fncychap
texlive-framed
texlive-geometry
texlive-hyperref
texlive-kvoptions
texlive-latex-bin
texlive-ltxcmds
texlive-needspace
texlive-oberdiek ;hypcap
texlive-parskip
texlive-preview
texlive-tabulary
texlive-titlesec
texlive-tools ;multicol, longtable
texlive-upquote
texlive-varwidth
texlive-wrapfig
texlive-xcolor))
(native-inputs
(list imagemagick ;for "convert"
nss-certs-for-test
python-cython
python-flit-core
python-pytest
(texlive-updmap.cfg
(list texlive-cm-super texlive-tex-gyre))))
(home-page "https://www.sphinx-doc.org")
(synopsis "Python documentation generator")
(description "Sphinx is a tool that makes it easy to create documentation
for Python projects or other documents consisting of multiple reStructuredText
sources.")
(license license:bsd-2)))
(define-public python-sphinx-5
(package
(inherit python-sphinx)
(version "5.3.0")
(source
(origin
(method url-fetch)
(uri (pypi-uri "Sphinx" version))
(sha256
(base32
"1dclwwz5rsvlw5rzyad1ar7i0zh4csni6jfp0lyc37zzm7h6s0ji"))))
(arguments
(list
#:test-flags
;; These require Internet access.
'(list "--ignore=tests/test_build_linkcheck.py"
"-k"
(string-append
"not test_latex_images"
;; XXX: Not clear why this fails with a version comparison
;; failure.
" and not test_needs_sphinx"
;; This is a harmless failure. The expected output looks for a
;; long string that happens to contain a literal space
;; character, but in the actual output the space character is
;; wrapped in <span class="w"> </span>.
" and not test_viewcode"
;; These fail with pygments 2.10+. They are harmless.
" and not test_additional_targets_should_not_be_translated"
" and not test_additional_targets_should_be_translated"))
#:phases
'(modify-phases %standard-phases
(add-before 'check 'pre-check
(lambda _
;; for test_cython
(setenv "HOME" "/tmp"))))))
(propagated-inputs
(list python-babel
python-colorama
python-docutils
python-filelock
python-html5lib
python-imagesize
python-importlib-metadata
python-jinja2
python-packaging
python-pygments
python-requests
python-snowballstemmer
python-sphinx-alabaster-theme
python-sphinxcontrib-applehelp
python-sphinxcontrib-devhelp
python-sphinxcontrib-htmlhelp
python-sphinxcontrib-jsmath
python-sphinxcontrib-qthelp
python-sphinxcontrib-serializinghtml
python-sphinxcontrib-websupport
python-types-requests
;; The Sphinx LaTeX library '\RequirePackage' or \\usepackage
;; these:
texlive-scheme-basic ;for a valid TeX Live tree
texlive-anyfontsize
texlive-capt-of
texlive-cm-super
texlive-cmap
texlive-etoolbox
texlive-fancyvrb
texlive-float
texlive-fncychap
texlive-fontspec
texlive-framed
texlive-luatex85
texlive-luatexbase
texlive-needspace
texlive-parskip
texlive-polyglossia
texlive-preview
texlive-tabulary
texlive-tex-gyre
texlive-titlesec
texlive-upquote
texlive-varwidth
texlive-wrapfig
texlive-xcolor))
(native-inputs
(list fontconfig
font-gnu-freefont
;; imagemagick is added for "convert". The store item does not
;; retain a reference to imagemagick, so it should be safe to use
;; 'imagemagick/stable' instead of 'imagemagick'. This is enforced
;; by the '#:disallowed-references' above.
imagemagick/stable
python-cython
python-flit-core
python-pytest
(texlive-updmap.cfg
(list texlive-cm-super texlive-tex-gyre))))))
;; Some packages do not support Sphinx 5 yet. Remove when unused.
(define-public python-sphinx-4
(package
(inherit python-sphinx-5)
(version "4.5.0")
(source (origin
(method url-fetch)
(uri (pypi-uri "Sphinx" version))
(sha256
(base32
"1rp28jryxwy24y8vpacclqihbizyi6b1s6id86pibvm46ybcmy3v"))))
(propagated-inputs
(modify-inputs (package-propagated-inputs python-sphinx)
(replace "python-docutils" python-docutils-0.15)))
(native-inputs
(modify-inputs (package-native-inputs python-sphinx)
(delete python-flit-core)
(append python-setuptools python-wheel)))))
(define-public python-sphinxcontrib-apidoc
(package
(name "python-sphinxcontrib-apidoc")
(version "0.3.0")
(source
(origin
(method url-fetch)
(uri (pypi-uri "sphinxcontrib-apidoc" version))
(sha256
(base32
"1f9zfzggs8a596jw51fpfmr149n05mrlyy859iydazbvry9gb6vj"))))
(build-system python-build-system)
(arguments
`(#:tests? #f)) ;requires python-pytest<4.0
(native-inputs
(list python-pbr
python-pytest
python-sphinx
python-testrepository))
(home-page "https://github.com/sphinx-contrib/apidoc")
(synopsis "Sphinx extension for running @code{sphinx-apidoc}")
(description "This package provides Sphinx extension for running
@code{sphinx-apidoc} on each build.")
(license license:bsd-2)))
(define-public python-sphinxcontrib-applehelp
(package
(name "python-sphinxcontrib-applehelp")
(version "1.0.2")
(source (origin
(method url-fetch)
(uri (pypi-uri "sphinxcontrib-applehelp" version))
(sha256
(base32
"0n5wrn4l7x6gxvi1g7c6y72hkxgc223axz1jykipaxhfr1g76wm0"))))
(build-system python-build-system)
(arguments
`(#:tests? #f)) ;XXX: circular dependency on Sphinx
(home-page "https://github.com/sphinx-doc/sphinxcontrib-applehelp")
(synopsis "Sphinx extension for creating Apple help books")
(description
"@code{sphinxcontrib-applehelp} is a Sphinx extension which outputs
Apple help books.")
(license license:bsd-2)))
(define-public python-sphinx-basic-ng
(package
(name "python-sphinx-basic-ng")
(version "1.0.0b2")
(source (origin
(method url-fetch)
(uri (pypi-uri "sphinx_basic_ng" version))
(sha256
(base32
"1jaihs22d8jfvk1fnv5j7hcza89hxj979ib0b4mh130cr53mmicy"))))
(build-system pyproject-build-system)
(propagated-inputs (list python-sphinx))
(native-inputs (list python-setuptools python-wheel))
(home-page "https://github.com/pradyunsg/sphinx-basic-ng")
(synopsis "Modernised skeleton for Sphinx themes")
(description
"This package provides a modern skeleton for Sphinx themes.")
(license license:expat)))
(define-public python-sphinx-click
(package
(name "python-sphinx-click")
(version "4.0.3")
(source
(origin
(method url-fetch)
(uri (pypi-uri "sphinx-click" version))
(sha256
(base32
"1nqy3b7wr64rbmdp7kpi723az53a89y6250h46i505g1rw0czam1"))))
(build-system python-build-system)
(arguments
(list #:phases #~(modify-phases %standard-phases
(replace 'check
(lambda* (#:key tests? #:allow-other-keys)
(when tests?
(invoke "pytest" "-vv" "tests")))))))
(native-inputs (list python-pbr python-pytest python-wheel))
(propagated-inputs (list python-click python-docutils python-sphinx))
(home-page "https://github.com/click-contrib/sphinx-click")
(synopsis "Sphinx extension that documents click applications")
(description "This package provide sphinx extension that automatically
documents click applications.")
(license license:expat)))
(define-public python-sphinx-copybutton
(package
(name "python-sphinx-copybutton")
(version "0.5.0")
(source
(origin
(method url-fetch)
(uri (pypi-uri "sphinx-copybutton" version))
(sha256
(base32
"1xl7jwcldqvfya2gdp1nfxma7rv35alk998dfnx2fg6hmpd5kh50"))))
(build-system python-build-system)
(arguments
`(#:tests? #f)) ; XXX: Check requires network access.
(propagated-inputs (list python-sphinx))
(home-page "https://github.com/choldgraf/sphinx-copybutton")
(synopsis "Sphinx extension to add \"copy\" buttons to code blocks")
(description
"This package provides a small sphinx extension to add \"copy\" buttons
to code blocks.")
(license license:expat)))
(define-public python-sphinx-design
(package
(name "python-sphinx-design")
(version "0.6.1")
(source
(origin
(method git-fetch) ; no tests in PyPI release
(uri (git-reference
(url "https://github.com/executablebooks/sphinx-design")
(commit (string-append "v" version))))
(file-name (git-file-name name version))
(sha256
(base32 "0n3bxibg9p16i3c3l0w8j0aw9pi9dggz1ixllgrmd9d5hdn6kl57"))))
(build-system pyproject-build-system)
(native-inputs
(list python-flit-core
python-pytest
python-pytest-cov
python-pytest-regressions))
(propagated-inputs
(list python-sphinx))
(home-page "https://sphinx-design.readthedocs.io/en/furo-theme/")
(synopsis "Sphinx extension to designing responsive web components")
(description
"This package provides a sphinx extension for designing beautiful, view
size responsive web components.")
(license license:expat)))
(define-public python-sphinxcontrib-devhelp
(package
(name "python-sphinxcontrib-devhelp")
(version "1.0.2")
(source (origin
(method url-fetch)
(uri (pypi-uri "sphinxcontrib-devhelp" version))
(sha256
(base32
"1r1qngsbjqbg4rj93kpj44qqy7n4x5khldkr0c3ffhlnggx1lzzz"))))
(build-system python-build-system)
(arguments
`(#:tests? #f)) ;XXX: circular dependency on Sphinx
(home-page "https://github.com/sphinx-doc/sphinxcontrib-devhelp")
(synopsis "Sphinx extension for creating Devhelp documents")
(description
"@code{sphinxcontrib-devhelp} is a Sphinx extension which outputs
@url{Devhelp,https://wiki.gnome.org/Apps/Devhelp} documents.")
(license license:bsd-2)))
(define-public python-sphinxcontrib-github-alt
(package
(name "python-sphinxcontrib-github-alt")
(version "1.2")
(source
(origin
(method url-fetch)
(uri (pypi-uri "sphinxcontrib_github_alt" version))
(sha256
(base32
"1x9af78vamjjcdrrhiah3wg613jv7gm8yh9vvqfrmf4vam6mimyg"))))
(build-system python-build-system)
(propagated-inputs
(list python-docutils python-sphinx))
(home-page "https://github.com/jupyter/sphinxcontrib_github_alt")
(synopsis "Link to GitHub pages from Sphinx docs")
(description
"This package lets you link to GitHub issues, pull requests, commits and
users from Sphinx docs.")
(license license:bsd-2)))
(define-public python-sphinxcontrib-htmlhelp
(package
(name "python-sphinxcontrib-htmlhelp")
(version "2.0.0")
(source (origin
(method url-fetch)
(uri (pypi-uri "sphinxcontrib-htmlhelp" version))
(sha256
(base32
"1ckd5xx4ngd6f4prxbc1bbvnafy1gg06j3bxyj5kk7v21lnvpy7m"))))
(build-system python-build-system)
(arguments
`(#:tests? #f)) ;XXX: circular dependency on Sphinx
(home-page "https://github.com/sphinx-doc/sphinxcontrib-htmlhelp")
(synopsis "Sphinx extension for rendering HTML help files")
(description
"@code{sphinxcontrib-htmlhelp} is a Sphinx extension which renders
HTML help files.")
(license license:bsd-2)))
(define-public python-sphinxcontrib-jsmath
(package
(name "python-sphinxcontrib-jsmath")
(version "1.0.1")
(source (origin
(method url-fetch)
(uri (pypi-uri "sphinxcontrib-jsmath" version))
(sha256
(base32
"1f64w19j33sp151jimibraw6qrbhd5gxy8hs3797w9478m55x4m9"))))
(build-system python-build-system)
(arguments
`(#:tests? #f)) ;XXX: circular dependency on Sphinx
(home-page "https://github.com/sphinx-doc/sphinxcontrib-jsmath")
(synopsis "Sphinx extension to render math equations")
(description
"@code{sphinxcontrib-jsmath} is a Sphinx extension which renders display
math in HTML via JavaScript.")
(license license:bsd-2)))
(define-public python-sphinxcontrib-newsfeed
(package
(name "python-sphinxcontrib-newsfeed")
(version "0.1.4")
(source (origin
(method url-fetch)
(uri (pypi-uri "sphinxcontrib-newsfeed" version))
(sha256
(base32
"1d7gam3mn8v4in4p16yn3v10vps7nnaz6ilw99j4klij39dqd37p"))))
(arguments '(#:tests? #f)) ; No tests.
(build-system python-build-system)
(propagated-inputs
(list python-sphinx))
(synopsis "News Feed extension for Sphinx")
(description "Sphinxcontrib-newsfeed is an extension for adding a simple
Blog, News or Announcements section to a Sphinx website.")
(home-page "https://bitbucket.org/prometheus/sphinxcontrib-newsfeed")
(license license:bsd-2)))
(define-public python-sphinx-inline-tabs
(package
(name "python-sphinx-inline-tabs")
(version "2023.4.21")
(source
(origin
(method url-fetch)
(uri (pypi-uri "sphinx_inline_tabs" version))
(sha256
(base32 "1g5yhdk208i8maippnbnijd1knpai809wl3cbwzqy59cc0zz3wjx"))))
(build-system pyproject-build-system)
(arguments
(list #:tests? #f)) ; no tests in the release, only in the main branch
(native-inputs (list python-flit-core
python-sphinx))
(home-page "https://github.com/pradyunsg/sphinx-inline-tabs")
(synopsis "Add inline tabbed content to your Sphinx documentation")
(description "This package provides a Sphinx plugin to add inline tabbed
content to your Sphinx documentation.")
(license license:expat)))
(define-public python-sphinx-issues
(package
(name "python-sphinx-issues")
(version "4.0.0")
(source
(origin
;; No tests in the PyPI tarball.
(method git-fetch)
(uri (git-reference
(url "https://github.com/sloria/sphinx-issues")
(commit version)))
(file-name (git-file-name name version))
(sha256
(base32 "0q4as8gibvin0n6h5y1q4cwz3b1nwgs0idfc94dbndx42pjiz1vn"))))
(build-system pyproject-build-system)
(arguments
(list
#:phases #~(modify-phases %standard-phases
(add-before 'check 'patch-sphinx-build-path
(lambda _
;; The path to the sphinx-build binary is hardcoded to
;; be in the same directory as the python
;; executable. That does not work when building the
;; package.
(substitute* "tests/test_sphinx_issues.py"
(((string-append "Path\\(sys\\.executable\\)"
"\\.parent\\.joinpath\\"
"(\"sphinx-build\"\\)"))
(string-append "\""
#$(this-package-native-input
"python-sphinx")
"/bin/sphinx-build\""))))))))
(native-inputs (list python-flit-core python-pytest python-sphinx))
(home-page "https://github.com/sloria/sphinx-issues")
(synopsis "Sphinx extension for linking to a project's issue tracker")
(description
"This package provides a Sphinx extension for linking to a project's
issue tracker. This includes roles for linking to issues, pull requests and
user profiles. Support for GitHub is built-in, but other services can also be
supported with @code{sphinx-issues}.")
(license license:expat)))
(define-public python-sphinx-panels
(package
(name "python-sphinx-panels")
(version "0.6.0")
(source
(origin
;; Tests not included in the pypi release.
(method git-fetch)
(uri (git-reference
(url "https://github.com/executablebooks/sphinx-panels")
(commit (string-append "v" version))))
(file-name (git-file-name name version))
(sha256
(base32 "1ivqz6yv96a2jp59kylg1gbkrmzq6zwilppz3ij0zrkjn25zb97k"))))
(build-system pyproject-build-system)
(propagated-inputs (list python-docutils-0.15 python-sphinx-4))
(native-inputs
(list python-pytest
python-pytest-regressions
python-setuptools
python-wheel))
(home-page "https://github.com/executablebooks/sphinx-panels")
(synopsis "Sphinx extension for creating panels in a grid layout")
(description
"This package provides a sphinx extension for creating panels in a
grid layout. It is no longer maintained and users are encouraged to use
@code{sphinx-design} instead.")
(license license:expat)))
(define-public python-sphinx-tabs
(package
(name "python-sphinx-tabs")
(version "3.4.1")
(home-page "https://github.com/executablebooks/sphinx-tabs")
(source (origin
(method url-fetch)
(uri (pypi-uri "sphinx-tabs" version))
(sha256
(base32
"0cmqw5ck2jcxqyf5ibz543idspq0g0fdzxh3fpah1r0nhfg9z86j"))))
(build-system python-build-system)
(arguments
'(#:tests? #f ;TODO: requires sphinx-testing and rinohtype
#:phases (modify-phases %standard-phases
(add-after 'unpack 'loosen-docutils-requirement
(lambda _
(substitute* "setup.py"
(("docutils~=0\\.18\\.0")
"docutils>=0.17.0")))))))
(propagated-inputs
(list python-docutils python-pygments python-sphinx))
(synopsis "Tabbed views for Sphinx")
(description
"Create tabbed content in Sphinx documentation when building HTML.")
(license license:expat)))
(define-public python-sphinxcontrib-programoutput
(package
(name "python-sphinxcontrib-programoutput")
(version "0.17")
(source (origin
(method url-fetch)
(uri (pypi-uri "sphinxcontrib-programoutput" version))
(sha256
(base32
"0zrb2ny6y7nk84qmw5mds84fc4pxgqf4sjy7bk95b0zfrawfj3ih"))))
(build-system python-build-system)
(propagated-inputs (list python-sphinx))
(synopsis "Sphinx extension to include program output")
(description "A Sphinx extension to literally insert the output of arbitrary
commands into documents, helping you to keep your command examples up to date.")
(home-page "https://github.com/NextThought/sphinxcontrib-programoutput")
(license license:bsd-2)))
(define-public python-sphinxcontrib-qthelp
(package
(name "python-sphinxcontrib-qthelp")
(version "1.0.3")
(source (origin
(method url-fetch)
(uri (pypi-uri "sphinxcontrib-qthelp" version))
(sha256
(base32
"0wjsp96d262shzkx7pb7pra7mmf0j8c5rz56i6x0vdsqw1z7ccsc"))))
(build-system python-build-system)
(arguments
`(#:tests? #f)) ;XXX: circular dependency on Sphinx
(home-page "https://github.com/sphinx-doc/sphinxcontrib-qthelp")
(synopsis "Sphinx extension to output QtHelp documents")
(description
"@code{sphinxcontrib-qthelp} is a Sphinx extension which outputs QtHelp
documents.")
(license license:bsd-2)))
(define-public python-sphinxcontrib-serializinghtml
(package
(name "python-sphinxcontrib-serializinghtml")
(version "1.1.5")
(source (origin
(method url-fetch)
(uri (pypi-uri "sphinxcontrib-serializinghtml" version))
(sha256
(base32
"0lk91cl9bi4ynhz971zjs0bsr7jwxx8mx2f40psrx06zvzjnspxa"))))
(build-system python-build-system)
(arguments
`(#:tests? #f)) ;XXX: circular dependency on Sphinx
(home-page "https://github.com/sphinx-doc/sphinxcontrib-serializinghtml")
(synopsis "Sphinx extension to serialize HTML files")
(description
"@code{sphinxcontrib-serializinghtml} is a Sphinx extension which outputs
\"serialized\" HTML files.")
(license license:bsd-2)))
(define-public python-sphinxcontrib-svg2pdfconverter
(package
(name "python-sphinxcontrib-svg2pdfconverter")
(version "1.2.0")
(source (origin
(method url-fetch)
(uri (pypi-uri "sphinxcontrib-svg2pdfconverter" version))
(sha256
(base32
"07c5nmkyx2y0gwfjq66fhy68c24mclvs2qqv1z9ilvvypii4blb0"))))
(build-system python-build-system)
(arguments '(#:tests? #f)) ;no tests
(propagated-inputs
(list python-sphinx))
(home-page
"https://github.com/missinglinkelectronics/sphinxcontrib-svg2pdfconverter")
(synopsis "Sphinx SVG to PDF converter extension")
(description "A Sphinx extension to convert SVG images to PDF in case the
builder does not support SVG images natively (e.g. LaTeX).")
(license license:bsd-2)))
(define-public python-sphinxcontrib-websupport
(package
(name "python-sphinxcontrib-websupport")
(version "1.2.4")
(source (origin
(method url-fetch)
(uri (pypi-uri "sphinxcontrib-websupport" version))
(sha256
(base32
"0ck2jphvs82vjcbphhd1h7j1xfi9ynv5d8g5b947qnk8l0ih5psf"))))
(build-system python-build-system)
(arguments
;; FIXME: Tests depend on Sphinx, which depends on this.
`(#:tests? #f))
(propagated-inputs
(list python-sphinxcontrib-serializinghtml))
(home-page "https://sphinx-doc.org/")
(synopsis "Sphinx API for web applications")
(description
"This package provides a Python API to easily integrate
Sphinx documentation into your web application. It provides tools to
integrate Sphinx documents in web templates and to handle searches.")
(license license:bsd-3)))
(define-public python-sphinx-gallery
(package
(name "python-sphinx-gallery")
(version "0.14.0")
(source
(origin
(method url-fetch)
(uri (pypi-uri "sphinx-gallery" version))
(sha256
(base32 "1hj380d5bjhbzxmhjw8f8b71jy1wk8crad0g3n750m990fphljia"))))
(build-system pyproject-build-system)
(arguments
(list
#:test-flags
'(list "--pyargs" "sphinx_gallery" "-k"
(string-append
;; These tests require online data.
"not test_embed_code_links_get_data"
" and not test_run_sphinx"
;; Requires webp support
" and not test_image_formats"
;; Needs graphviz
" and not test_rebuild"
;; Fails because we've deleted an example file, so the numbers
;; don't match.
" and not test_junit"
;; AssertionError.
" and not test_embed_links_and_styles"))
#:phases
'(modify-phases %standard-phases
;; TODO: Our version of matplotlib does not support webp.
(add-after 'unpack 'delete-webp-example
(lambda _
(delete-file "sphinx_gallery/tests/tinybuild/examples/plot_webp.py"))))))
(propagated-inputs
(list python-jupyterlite-sphinx))
(native-inputs
(list python-joblib
python-matplotlib
python-numpy
python-pillow
python-pytest
python-pytest-cov
python-setuptools
python-sphinx
python-wheel))
(home-page "https://sphinx-gallery.github.io/stable/index.html")
(synopsis "Generate an examples gallery automatically")
(description
"@code{sphinx_gallery} is a Sphinx extension that builds an HTML version
from any set of Python scripts and puts it into an examples gallery.")
(license license:bsd-3)))
(define-public python-sphinx-me
(package
(name "python-sphinx-me")
(version "0.3")
(source
(origin
(method url-fetch)
(uri (pypi-uri "sphinx-me" version))
(sha256
(base32
"06jzgp213zihnvpcy2y5jy3ykid3apc2ncp2pg6a2g05lhiziglq"))))
(build-system python-build-system)
(home-page "https://github.com/stephenmcd/sphinx-me")
(synopsis "Create a Sphinx documentation shell")
(description
"Create a Sphinx documentation shell for your project and include the
README file as the documentation index. It handles extracting the required
meta data such as the project name, author and version from your project for
use in your Sphinx docs.")
(license license:bsd-2)))
(define-public python-sphinx-repoze-autointerface
(package
(name "python-sphinx-repoze-autointerface")
(version "0.8")
(source (origin
(method url-fetch)
(uri (pypi-uri "repoze.sphinx.autointerface" version))
(sha256
(base32
"08ycivzf7bh4a1zcyp31hbyqs1b2c9r26raa3vxjwwmbfqr3iw4f"))))
(build-system python-build-system)
(arguments '(#:tests? #f)) ; No tests.
(propagated-inputs
(list python-sphinx python-zope-interface))
(synopsis "Auto-generate Sphinx API docs from Zope interfaces")
(description "This package defines an extension for the Sphinx documentation
system. The extension allows generation of API documentation by
introspection of @code{zope.interface} instances in code.")
(home-page "https://github.com/repoze/repoze.sphinx.autointerface")
(license license:repoze)))
(define-public python-sphinx-prompt
(package
(name "python-sphinx-prompt")
(version "1.9.0")
(source
(origin
(method url-fetch)
(uri (pypi-uri "sphinx_prompt" version))
(sha256
(base32 "18cmx6d5582jdaq32vnl1slfkm2zhr0raz8nkc57ikkd8rnkq6s7"))))
(build-system pyproject-build-system)
(arguments (list #:tests? #f)) ;no tests in pypi sdist
(native-inputs (list python-poetry-core))
(propagated-inputs
(list python-certifi
python-docutils
python-idna
python-pygments
python-sphinx
python-urllib3))
(home-page "https://github.com/sbrunner/sphinx-prompt")
(synopsis "Sphinx directive to add unselectable prompt")
(description
"This package provides a Sphinx directive to add unselectable prompt.")
(license license:bsd-3)))
(define-public python-sphinx-alabaster-theme
(package
(name "python-sphinx-alabaster-theme")
(version "0.7.13")
(source (origin
(method url-fetch)
(uri (pypi-uri "alabaster" version))
(sha256
(base32
"1qjam3hks6a3fa89nhb9ajk62b2m5qmss0qyw0b0wsay9l44lym2"))))
(build-system pyproject-build-system)
(propagated-inputs
(list python-pygments))
(native-inputs (list python-setuptools python-wheel))
(home-page "https://alabaster.readthedocs.io/")
(synopsis "Configurable sidebar-enabled Sphinx theme")
(description "Alabaster is a visually (c)lean, responsive, configurable
theme for the Sphinx documentation system. It's the default theme of Sphinx.")
(license license:bsd-3)))
(define-public python-sphinx-argparse
(package
(name "python-sphinx-argparse")
(version "0.3.1")
(source
(origin
(method url-fetch)
(uri (pypi-uri "sphinx-argparse" version))
(sha256
(base32 "07nw68nrbpzsswb5bz8gdb5allgj6jnz8m81afhr9v6c8fyiq5c2"))))
(build-system python-build-system)
(propagated-inputs
(list python-sphinx))
(native-inputs
(list python-commonmark python-pytest python-sphinx-rtd-theme))
(home-page "https://github.com/ribozz/sphinx-argparse")
(synopsis "Sphinx extension for documenting argparse commands and options")
(description
"This package is a sphinx extension that automatically documents
argparse commands and options")
(license license:expat)))
;;; FIXME: Currently broken by Jinja >= 3.10 (see:
;;; https://foss.heptapod.net/doc-utils/cloud_sptheme/-/issues/47).
(define-public python-sphinx-cloud-sptheme
(package
(name "python-sphinx-cloud-sptheme")
(version "1.10.1")
(source (origin
(method hg-fetch)
(uri (hg-reference
(url "https://foss.heptapod.net/doc-utils/cloud_sptheme")
(changeset version)))
(file-name (hg-file-name name version))
(sha256
(base32
"0k0pgi0vcn8vdy3k6x11fpp4mqp7p3l6n6pjfi3mir3vwjhdfz7l"))))
(build-system python-build-system)
(native-inputs (list python-mock))
(propagated-inputs (list python-sphinx))
(home-page "https://foss.heptapod.net/doc-utils/cloud_sptheme")
(synopsis "Cloud theme for Sphinx")
(description "This package contains the @emph{Cloud} theme for Sphinx and
some related extensions.")
(license license:bsd-3)))
(define-public python-guzzle-sphinx-theme
(package
(name "python-guzzle-sphinx-theme")
(version "0.7.11")
(source
(origin
(method url-fetch)
(uri (pypi-uri "guzzle_sphinx_theme" version))
(sha256
(base32
"1rnkzrrsbnifn3vsb4pfaia3nlvgvw6ndpxp7lzjrh23qcwid34v"))))
(build-system python-build-system)
(propagated-inputs
(list python-sphinx))
(home-page "https://github.com/guzzle/guzzle_sphinx_theme")
(synopsis "Sphinx theme used by Guzzle")
(description "This package provides guzzle_sphinx_theme, a theme for the
Sphinx documentation system, used by @uref{http://docs.guzzlephp.org, Guzzle}
and several other projects.")
(license license:expat)))
(define-public python-mpl-sphinx-theme
(package
(name "python-mpl-sphinx-theme")
(version "3.5.0")
(source
(origin
(method url-fetch)
(uri (pypi-uri "mpl_sphinx_theme" version))
(sha256
(base32 "0ilsw6s5hfvjzqs3258c8gmg5v3dwa6k69mwmkxsyh1qmv15krpw"))))
(build-system python-build-system)
(propagated-inputs (list python-pydata-sphinx-theme))
(home-page "https://github.com/matplotlib/mpl-sphinx-theme")
(synopsis "Matplotlib theme for Sphinx")
(description "This package provides a Matplotlib theme for Sphinx.")
(license license:bsd-3)))
(define-public python-myst-parser
(package
(name "python-myst-parser")
(version "3.0.1")
(source (origin
(method git-fetch) ;for tests
(uri (git-reference
(url "https://github.com/executablebooks/MyST-Parser")
(commit (string-append "v" version))))
(file-name (git-file-name name version))
(sha256
(base32
"0lac1mf9pnbmr1jcllhh0sh0y4cnmncx36g2mjbwyd6rm6akbajc"))))
(build-system pyproject-build-system)
(arguments
(list
#:test-flags
;; "Currently only dot format is supported."
'(list "--ignore=tests/test_renderers/test_parse_directives.py")))
(native-inputs
(list python-beautifulsoup4
python-docutils
python-flit-core
python-pytest
python-pytest-param-files
python-pytest-regressions
python-sphinx
python-sphinx-pytest))
(propagated-inputs
(list python-docutils
python-jinja2
python-linkify-it-py
python-markdown-it-py
python-linkify-it-py
python-mdit-py-plugins
python-pyyaml
python-sphinx
python-typing-extensions))
(home-page "https://myst-parser.readthedocs.io/en/latest/")
(synopsis "Sphinx and Docutils extension to parse MyST")
(description "This package provides a Sphinx and Docutils extension to parse
MyST, a rich and extensible flavour of Markdown for authoring technical and
scientific documentation.")
(license license:expat)))
(define-public python-sphinx-rtd-theme
(package
(name "python-sphinx-rtd-theme")
(version "1.0.0")
(source
(origin
(method url-fetch)
(uri (pypi-uri "sphinx_rtd_theme" version))
(sha256
(base32
"0p3abj91c3l72ajj5jwblscsdf1jflrnn0djx2h5y6f2wjbx9ipf"))))
(build-system python-build-system)
(arguments
(list
#:tests? #f ; No tests.
#:phases
#~(modify-phases %standard-phases
(add-after 'unpack 'allow-newer-docutil
(lambda _
(substitute* "setup.py"
(("docutils<0.18") "docutils<0.20")))))))
(propagated-inputs (list python-docutils python-sphinx))
(home-page "https://github.com/snide/sphinx_rtd_theme/")
(synopsis "ReadTheDocs.org theme for Sphinx")
(description "A theme for Sphinx used by ReadTheDocs.org.")
(license license:expat)))
(define-public python-breathe
(package
(name "python-breathe")
(version "4.35.0")
(source (origin
(method git-fetch) ;git repo has tests
(uri (git-reference
(url "https://github.com/breathe-doc/breathe")
(commit (string-append "v" version))))
(file-name (git-file-name name version))
(sha256
(base32
"1hlcrhr533yjkz9ds83xnmn8h6z3r6vfzz7qrpy14n9j4ysyz59c"))))
(build-system python-build-system)
(arguments
(list #:phases #~(modify-phases %standard-phases
(replace 'check
(lambda* (#:key tests? #:allow-other-keys)
(when tests?
(with-directory-excursion "tests"
(invoke "python" "-m" "pytest" "-v"))))))))
(native-inputs (list python-pytest))
(propagated-inputs (list python-docutils python-sphinx))
(home-page "https://www.breathe-doc.org")
(synopsis "ReStructuredText and Sphinx bridge to Doxygen")
(description "This package is an extension to reStructuredText and Sphinx
to be able to read and render the Doxygen xml output.")
(license license:bsd-3)))
(define-public python-sphinx-intl
(package
(name "python-sphinx-intl")
(version "2.0.1")
(source
(origin
(method url-fetch)
(uri (pypi-uri "sphinx-intl" version))
(sha256
(base32 "1d1q0sanjp4nkfvhsxi75zf3xjyyi8nzxvl3v7l0jy9ld70nwnmj"))))
(build-system python-build-system)
(propagated-inputs
(list python-sphinx python-click))
(home-page "https://github.com/sphinx-doc/sphinx-intl")
(synopsis
"Sphinx utility that makes it easy to translate and to apply translation")
(description
"A utility tool that provides several features that make it easy to
translate and to apply translation to Sphinx generated document.")
(license license:bsd-2)))
(define-public python-sphinxext-opengraph
(package
(name "python-sphinxext-opengraph")
(version "0.6.3")
(source
(origin
(method git-fetch) ; no tests in PyPI release
(uri (git-reference
(url "https://github.com/wpilibsuite/sphinxext-opengraph")
(commit (string-append "v" version))))
(file-name (git-file-name name version))
(sha256
(base32 "1wrgpan9z65fv4hbvisz4sypc4w5ammnxkyn5lhr43wdr6b967k1"))))
(build-system python-build-system)
(arguments
`(#:phases
(modify-phases %standard-phases
(replace 'check
(lambda* (#:key tests? #:allow-other-keys)
(when tests?
(invoke "pytest" "-vv")))))))
(native-inputs (list python-beautifulsoup4 python-pytest python-sphinx))
(home-page "https://github.com/wpilibsuite/sphinxext-opengraph")
(synopsis "Sphinx Extension to enable OpenGraph support")
(description
"This package provides a Sphinx Extension to generate OG metadata.")
(license license:bsd-3)))
(define-public python-sphinxext-rediraffe
(package
(name "python-sphinxext-rediraffe")
(version "0.2.7")
(source
(origin
(method url-fetch)
(uri (pypi-uri "sphinxext-rediraffe" version))
(sha256
(base32 "0pbjkwmqc8q08bsk66panvpya831ycjq1ysdagyrznpzwpxcn7b5"))))
(build-system pyproject-build-system)
(arguments
(list
#:phases
#~(modify-phases %standard-phases
(add-after 'unpack 'patch-version
(lambda _
(substitute* "setup.py"
(("version = \"main\"")
(string-append "version = \"" #$version "\""))))))))
(propagated-inputs (list python-sphinx))
(native-inputs (list python-setuptools python-wheel))
(home-page "https://github.com/wpilibsuite/sphinxext-rediraffe")
(synopsis
"Sphinx Extension that redirects non-existent pages to working pages")
(description
"This sphinx extension redirects non-existent pages to working
pages. Rediraffe can also check that deleted/renamed files in your git repo
are redirected.")
(license license:expat)))
(define-public python-sphinx-autobuild
(package
(name "python-sphinx-autobuild")
(version "2021.3.14")
(source
(origin
(method url-fetch)
(uri (pypi-uri "sphinx-autobuild" version))
(sha256
(base32
"019z8kvnaw11r41b6pfdy9iz4iwyr0s51hs0a5djn797dsva676y"))))
(build-system python-build-system)
(arguments
'(#:phases
(modify-phases %standard-phases
(replace 'check
(lambda* (#:key tests? #:allow-other-keys)
(when tests?
(invoke "pytest" "-vv")))))))
(propagated-inputs
(list python-colorama python-livereload python-sphinx))
(native-inputs
(list python-pytest))
(home-page "https://github.com/GaretJax/sphinx-autobuild")
(synopsis "Rebuild Sphinx documentation when a change is detected")
(description
"This package lets you watch a Sphinx directory and rebuild the
documentation when a change is detected. It also includes a livereload
enabled web server.")
(license license:expat)))
(define-public python-sphinx-autodoc-typehints
(package
(name "python-sphinx-autodoc-typehints")
(version "1.23.0")
(source
(origin
(method git-fetch) ;no tests in pypi archive
(uri (git-reference
(url "https://github.com/tox-dev/sphinx-autodoc-typehints")
(commit version)))
(file-name (git-file-name name version))
(sha256
(base32
"0z5na9cxqq4xc9ikig1s2fwbwl5pjwm04z9zwidbp2lm6k53xs8b"))))
(build-system pyproject-build-system)
(arguments
(list
;; This test requires to download an objects.inv file
;; from the Sphinx website.
#:test-flags '(list "-k" "not test_format_annotation")
#:phases
#~(modify-phases %standard-phases
(add-before 'build 'pretend-version
;; The version string is usually derived via setuptools-scm, but
;; without the git metadata available, the version string is set to
;; '0.0.0'.
(lambda _
(setenv "SETUPTOOLS_SCM_PRETEND_VERSION" #$version))))))
(native-inputs
(list nss-certs-for-test
python-hatch-vcs
python-hatchling
python-nptyping
python-pytest
python-setuptools-scm
python-sphobjinv
python-typing-extensions))
(propagated-inputs
(list python-sphinx))
(home-page "https://pypi.org/project/sphinx-autodoc-typehints/")
(synopsis "Type hints for the Sphinx autodoc extension")
(description "This extension allows you to use Python 3 annotations for
documenting acceptable argument types and return value types of functions.")
(license license:expat)))
(define-public python-sphinx-autodoc-typehints-5
(package/inherit python-sphinx-autodoc-typehints
(propagated-inputs
(modify-inputs
(package-propagated-inputs python-sphinx-autodoc-typehints)
(replace "python-sphinx" python-sphinx-5)))))
(define-public python-sphinx-pytest
(package
(name "python-sphinx-pytest")
(version "0.2.0")
(source (origin
(method url-fetch)
(uri (pypi-uri "sphinx_pytest" version))
(sha256
(base32
"0w16w7zjhb6pxv7py7q13882r58ly4s71l2lyns0wq6qkv1za9iw"))))
(build-system pyproject-build-system)
(native-inputs (list python-flit-core))
(propagated-inputs (list python-pytest python-sphinx))
(home-page "https://github.com/chrisjsewell/sphinx-pytest")
(synopsis "Pytest fixtures for Sphinx extensions")
(description "This Pytest extension mainly provides some Pytest fixtures
to simulate converting some source text to Docutils @acronym{AST, Abstract
Syntax Tree} at different stages: before transforms, after transforms, etc.")
(license license:expat)))
(define-public python-nbsphinx
(package
(name "python-nbsphinx")
(version "0.8.8")
(source
(origin
(method url-fetch)
(uri (pypi-uri "nbsphinx" version))
(sha256
(base32
"1v1lzkfx2lslhslqb110zxmm4dmdg6hs2rahf713c2rk9f10q2dm"))))
(build-system python-build-system)
(propagated-inputs
(list python-docutils
python-jinja2
python-nbconvert
python-nbformat
python-sphinx
python-traitlets))
(home-page "https://nbsphinx.readthedocs.io/")
(synopsis "Jupyter Notebook Tools for Sphinx")
(description "@code{python-nbsphinx} is a Sphinx extension that
provides a source parser for @code{*.ipynb} files. Custom Sphinx
directives are used to show Jupyter Notebook code cells (and of course
their results) in both HTML and LaTeX output. Un-evaluated notebooks
- i.e. notebooks without stored output cells - will be automatically
executed during the Sphinx build process.")
(license license:expat)))
(define-public python-sphobjinv
(package
(name "python-sphobjinv")
(version "2.3.1.1")
(source
(origin
(method url-fetch)
(uri (pypi-uri "sphobjinv" version))
(sha256
(base32
"10x4g92agj6aai0lj0xpcx58zlm1zamzws1w9dczsl1izpz07ij7"))
(patches (search-patches
"python-sphobjinv-defer-ssl-import.patch"))))
(build-system python-build-system)
(arguments
(list
#:phases
#~(modify-phases %standard-phases
(replace 'check
(lambda* (#:key tests? #:allow-other-keys)
(when tests?
(invoke "pytest")))))))
(native-inputs
(list python-dictdiffer python-pytest python-pytest-check
python-sphinx python-stdio-mgr))
(propagated-inputs
(list python-attrs python-certifi python-jsonschema))
(home-page "https://github.com/bskinn/sphobjinv")
(synopsis "Sphinx cross-reference tool")
(description "Sphinx objects.inv inspection/manipulation tool.")
(license license:expat)))
(define-public python-jupyter-sphinx
(package
(name "python-jupyter-sphinx")
(version "0.3.2")
(source
(origin
;; Pypi tarball doesn't contain tests.
(method git-fetch)
(uri (git-reference
(url "https://github.com/jupyter/jupyter-sphinx")
(commit (string-append "v" version))))
(file-name (git-file-name name version))
(sha256
(base32
"0bsb17vzbgvrzvh87pi88b157hyigdwnf1lhrgvan03i2300h15c"))))
(build-system python-build-system)
(arguments
(list
#:phases
#~(modify-phases %standard-phases
(replace 'check
(lambda* (#:key tests? #:allow-other-keys)
(when tests?
(invoke "pytest")))))))
(propagated-inputs
(list python-ipython python-ipywidgets python-nbconvert
python-nbformat))
(native-inputs
(list python-pytest python-sphinx))
(home-page "https://github.com/jupyter/jupyter-sphinx/")
(synopsis "Jupyter Sphinx Extensions")
(description
"Jupyter-sphinx is a Sphinx extension that executes embedded code in a
Jupyter kernel, and embeds outputs of that code in the document. It has
support for rich output such as images, LaTeX math and even JavaScript
widgets, and supports thebelab for live code execution with minimal effort.")
(license license:bsd-3)))
(define-public python-sphinxcontrib-autoprogram
(package
(name "python-sphinxcontrib-autoprogram")
(version "0.1.8")
(source
(origin
(method url-fetch)
(uri (pypi-uri "sphinxcontrib-autoprogram" version))
(sha256
(base32
"02pi450qml429disph075jyqwjrawrhbsjfkqvjf10yjp6fp4sas"))))
(build-system python-build-system)
(propagated-inputs
(list python-six python-sphinx))
(home-page "https://github.com/sphinx-contrib/autoprogram")
(synopsis "Documenting CLI programs")
(description
"This Sphinx extension, @code{sphinxcontrib.autoprogram}, provides an
automated way to document command-line programs. It scans
@code{argparse.ArgumentParser} object, and then expands it into a set of
@code{.. program::} and @code{.. option::} directives.")
(license license:bsd-2)))
(define-public python-sphinx-theme-builder
(package
(name "python-sphinx-theme-builder")
(version "0.2.0b1")
(source
(origin
(method git-fetch) ;no tests in pypi archive
(uri (git-reference
(url "https://github.com/pradyunsg/sphinx-theme-builder")
(commit version)))
(file-name (git-file-name name version))
(sha256
(base32
"15gvwzd4l3wcmd6fns8xvv44yzxmamr1nfn28mp12sdw2y10v2ba"))))
(build-system python-build-system)
(arguments
(list
#:phases
#~(modify-phases %standard-phases
;; XXX: PEP 517 manual build copied from python-isort.
(replace 'build
(lambda _
;; ZIP does not support timestamps before 1980.
(setenv "SOURCE_DATE_EPOCH" "315532800")
(invoke "python" "-m" "build" "--wheel" "--no-isolation" ".")))
(replace 'check
(lambda* (#:key tests? #:allow-other-keys)
(when tests?
(invoke "pytest" "-vv"))))
(replace 'install
(lambda _
(let ((whl (car (find-files "dist" "\\.whl$"))))
(invoke "pip" "--no-cache-dir" "--no-input"
"install" "--no-deps" "--prefix" #$output whl)))))))
(native-inputs (list python-flit-core python-pytest))
(propagated-inputs
(list python-pypa-build
python-click
python-nodeenv
python-packaging
python-pyproject-metadata
python-rich
python-sphinx-autobuild
python-tomli))
(home-page "https://github.com/pradyunsg/sphinx-theme-builder")
(synopsis "Tool for authoring Sphinx themes")
(description "This package provides a tool for authoring Sphinx themes
with a simple (opinionated) workflow.")
(license license:expat)))
(define-public python-sphinx-sitemap
(package
(name "python-sphinx-sitemap")
(version "2.2.0")
(source
(origin
(method url-fetch)
(uri (pypi-uri "sphinx-sitemap" version))
(sha256
(base32 "0dvpryrz7vn8rvayzy5nrmqy4wyzlaxcx88bl46prc9w4cwxmbb5"))))
(build-system python-build-system)
(propagated-inputs (list python-sphinx))
(home-page "https://github.com/jdillard/sphinx-sitemap")
(synopsis "Sitemap generator for Sphinx")
(description "A Sphinx extension to generate multiversion and
multilanguage sitemaps.org compliant sitemaps for the HTML version of your
Sphinx documentation.")
(license license:expat)))
(define-public python-pydata-sphinx-theme
(package
(name "python-pydata-sphinx-theme")
;; TODO: This is not the latest release, but the 0.8.x series introduced a
;; new Sphinx theme build system that complicate things (see:
;; https://github.com/pydata/pydata-sphinx-theme/issues/628 and
;; https://src.fedoraproject.org/rpms/python-pydata-sphinx-theme
;; /blob/rawhide/f/prepare_vendor.sh).
(version "0.7.2")
(source
(origin
(method url-fetch)
(uri (pypi-uri "pydata-sphinx-theme" version))
(sha256
(base32
"0ph69bnnw9w8vksc7rk45q5yknsrsgk9a19xsbxym46jrmgz67b7"))))
(build-system pyproject-build-system)
(arguments
(list
#:test-flags
;; Fails due to inscrutable differences in the generated HTML
'(list "-k" "not test_logo")))
(propagated-inputs
(list python-beautifulsoup4
python-docutils
python-jinja2
python-sphinx))
(native-inputs
(list python-pytest python-pytest-regressions
python-setuptools python-wheel))
(home-page "https://github.com/pydata/pydata-sphinx-theme")
(synopsis "Bootstrap-based Sphinx theme")
(description
"This package provides a Bootstrap-based Sphinx theme from the PyData
community.")
(license license:bsd-3)))
|