gnu: Add python-pymd4c.
[jackhill/guix/guix.git] / gnu / packages / sphinx.scm
CommitLineData
9d0c291e
MB
1;;; GNU Guix --- Functional package management for GNU
2;;; Copyright © 2014 David Thompson <davet@gnu.org>
e9f93cd5 3;;; Copyright © 2015, 2017, 2019, 2020 Ricardo Wurmus <rekado@elephly.net>
9d0c291e
MB
4;;; Copyright © 2015, 2016, 2017 Leo Famulari <leo@famulari.name>
5;;; Copyright © 2016 Hartmut Goebel <h.goebel@crazy-compilers.com>
6;;; Copyright © 2016, 2017, 2018, 2019 Marius Bakke <mbakke@fastmail.com>
7;;; Copyright © 2017 Danny Milosavljevic <dannym+a@scratchpost.org>
f49b8c14 8;;; Copyright © 2017, 2018, 2020 Tobias Geerinckx-Rice <me@tobias.gr>
9d0c291e
MB
9;;; Copyright © 2017 Frederick M. Muriithi <fredmanglis@gmail.com>
10;;; Copyright © 2017 Christopher Allan Webber <cwebber@dustycloud.org>
11;;; Copyright © 2017 Julien Lepiller <julien@lepiller.eu>
12;;; Copyright © 2019 Efraim Flashner <efraim@flashner.co.il>
13;;; Copyright © 2019 Nicolas Goaziou <mail@nicolasgoaziou.fr>
90ee17cd 14;;; Copyright © 2019 Alexandros Theodotou <alex@zrythm.org>
0066f6be 15;;; Copyright © 2019 Brett Gilio <brettg@gnu.org>
83ade5bf 16;;; Copyright © 2020 Giacomo Leidi <goodoldpaul@autistici.org>
9d0c291e
MB
17;;;
18;;; This file is part of GNU Guix.
19;;;
20;;; GNU Guix is free software; you can redistribute it and/or modify it
21;;; under the terms of the GNU General Public License as published by
22;;; the Free Software Foundation; either version 3 of the License, or (at
23;;; your option) any later version.
24;;;
25;;; GNU Guix is distributed in the hope that it will be useful, but
26;;; WITHOUT ANY WARRANTY; without even the implied warranty of
27;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28;;; GNU General Public License for more details.
29;;;
30;;; You should have received a copy of the GNU General Public License
31;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
32
33(define-module (gnu packages sphinx)
34 #:use-module (guix packages)
35 #:use-module (guix download)
d090a1c1 36 #:use-module (guix git-download)
d309b36d 37 #:use-module (guix utils)
9d0c291e
MB
38 #:use-module (guix build-system python)
39 #:use-module ((guix licenses) #:prefix license:)
40 #:use-module (gnu packages)
41 #:use-module (gnu packages check)
42 #:use-module (gnu packages graphviz)
43 #:use-module (gnu packages image)
44 #:use-module (gnu packages imagemagick)
dbcd2050 45 #:use-module (gnu packages python-build)
9d0c291e
MB
46 #:use-module (gnu packages python-web)
47 #:use-module (gnu packages python-xyz)
48 #:use-module (gnu packages time))
49
50(define-public python-sphinx
51 (package
52 (name "python-sphinx")
9fe0ca40 53 (version "3.3.1")
9d0c291e
MB
54 (source
55 (origin
56 (method url-fetch)
57 (uri (pypi-uri "Sphinx" version))
58 (sha256
59 (base32
9fe0ca40 60 "0023vc2i29pjxmvdqbz1wdbi7gbj56y1br1b2z8h8wa44li5k38y"))))
9d0c291e
MB
61 (build-system python-build-system)
62 (arguments
63 `(#:phases
64 (modify-phases %standard-phases
65 (replace 'check
66 (lambda _
67 ;; Requires Internet access.
68 (delete-file "tests/test_build_linkcheck.py")
69 (substitute* "tests/test_build_latex.py"
70 (("@pytest.mark.sphinx\\('latex', testroot='images'\\)")
71 "@pytest.mark.skip()"))
9d0c291e
MB
72 (invoke "make" "test"))))))
73 (propagated-inputs
4b8c8f76 74 `(("python-babel" ,python-babel)
9d0c291e
MB
75 ("python-docutils" ,python-docutils)
76 ("python-jinja2" ,python-jinja2)
4b8c8f76 77 ("python-imagesize" ,python-imagesize)
9d0c291e
MB
78 ("python-packaging" ,python-packaging)
79 ("python-pygments" ,python-pygments)
80 ("python-requests" ,python-requests)
4b8c8f76
BG
81 ("python-snowballstemmer" ,python-snowballstemmer)
82 ("python-sphinx-alabaster-theme"
83 ,python-sphinx-alabaster-theme)
d309b36d
MB
84 ("python-sphinxcontrib-applehelp" ,python-sphinxcontrib-applehelp)
85 ("python-sphinxcontrib-devhelp" ,python-sphinxcontrib-devhelp)
86 ("python-sphinxcontrib-htmlhelp" ,python-sphinxcontrib-htmlhelp)
87 ("python-sphinxcontrib-jsmath" ,python-sphinxcontrib-jsmath)
88 ("python-sphinxcontrib-qthelp" ,python-sphinxcontrib-qthelp)
89 ("python-sphinxcontrib-serializinghtml"
90 ,python-sphinxcontrib-serializinghtml)))
9d0c291e
MB
91 (native-inputs
92 `(("graphviz" ,graphviz)
93 ("imagemagick" ,imagemagick) ;for "convert"
94 ("python-html5lib" ,python-html5lib)
95 ("python-mock" ,python-mock)
96 ("python-nose" ,python-nose)
97 ("python-pytest" ,python-pytest)))
555f3d15 98 (home-page "https://www.sphinx-doc.org")
9d0c291e
MB
99 (synopsis "Python documentation generator")
100 (description "Sphinx is a tool that makes it easy to create documentation
101for Python projects or other documents consisting of multiple reStructuredText
102sources.")
50bb74d0 103 (license license:bsd-2)
45f7dc37 104 (properties `((python2-variant . ,(delay python-sphinx))))))
9d0c291e 105
bc2a3f7c
MB
106(define-public python-sphinxcontrib-applehelp
107 (package
108 (name "python-sphinxcontrib-applehelp")
f49b8c14 109 (version "1.0.2")
bc2a3f7c
MB
110 (source (origin
111 (method url-fetch)
112 (uri (pypi-uri "sphinxcontrib-applehelp" version))
113 (sha256
114 (base32
f49b8c14 115 "0n5wrn4l7x6gxvi1g7c6y72hkxgc223axz1jykipaxhfr1g76wm0"))))
bc2a3f7c
MB
116 (build-system python-build-system)
117 (arguments
118 `(#:tests? #f)) ;XXX: circular dependency on Sphinx
119 (home-page "https://github.com/sphinx-doc/sphinxcontrib-applehelp")
120 (synopsis "Sphinx extension for creating Apple help books")
121 (description
122 "@code{sphinxcontrib-applehelp} is a Sphinx extension which outputs
123Apple help books.")
124 (license license:bsd-2)))
125
bcb22b36
RW
126(define-public python-sphinx-copybutton
127 (package
128 (name "python-sphinx-copybutton")
8d45404e 129 (version "0.2.6")
bcb22b36
RW
130 (source
131 (origin
132 (method url-fetch)
133 (uri (pypi-uri "sphinx-copybutton" version))
134 (sha256
135 (base32
8d45404e 136 "0ny9jpygj93z8jyjpi4v6jjz90pmns74s389wq16igzzq2mpgfjm"))))
bcb22b36 137 (build-system python-build-system)
8d45404e
BG
138 (arguments
139 `(#:tests? #f)) ; XXX: Check requires network access.
140 (propagated-inputs
141 `(("python-flit" ,python-flit)
142 ("python-setuptools" ,python-setuptools)
143 ("python-sphinx" ,python-sphinx)
144 ("python-wheel" ,python-wheel)))
bcb22b36
RW
145 (home-page "https://github.com/choldgraf/sphinx-copybutton")
146 (synopsis "Sphinx extension to add \"copy\" buttons to code blocks")
147 (description
148 "This package provides a small sphinx extension to add \"copy\" buttons
149to code blocks.")
150 (license license:expat)))
151
62ad0c8b
MB
152(define-public python-sphinxcontrib-devhelp
153 (package
154 (name "python-sphinxcontrib-devhelp")
ccac5118 155 (version "1.0.2")
62ad0c8b
MB
156 (source (origin
157 (method url-fetch)
158 (uri (pypi-uri "sphinxcontrib-devhelp" version))
159 (sha256
160 (base32
ccac5118 161 "1r1qngsbjqbg4rj93kpj44qqy7n4x5khldkr0c3ffhlnggx1lzzz"))))
62ad0c8b
MB
162 (build-system python-build-system)
163 (arguments
164 `(#:tests? #f)) ;XXX: circular dependency on Sphinx
165 (home-page "https://github.com/sphinx-doc/sphinxcontrib-devhelp")
166 (synopsis "Sphinx extension for creating Devhelp documents")
167 (description
168 "@code{sphinxcontrib-devhelp} is a Sphinx extension which outputs
169@url{Devhelp,https://wiki.gnome.org/Apps/Devhelp} documents.")
170 (license license:bsd-2)))
171
72f278a0
MB
172(define-public python-sphinxcontrib-htmlhelp
173 (package
174 (name "python-sphinxcontrib-htmlhelp")
25b576a9 175 (version "1.0.3")
72f278a0
MB
176 (source (origin
177 (method url-fetch)
178 (uri (pypi-uri "sphinxcontrib-htmlhelp" version))
179 (sha256
180 (base32
25b576a9 181 "16v5jdnibwrqjdr5aqchgyzpwy3rgamwhdf4kidv5nxj65zbpxg8"))))
72f278a0
MB
182 (build-system python-build-system)
183 (arguments
184 `(#:tests? #f)) ;XXX: circular dependency on Sphinx
185 (home-page "https://github.com/sphinx-doc/sphinxcontrib-htmlhelp")
35fc0f4c 186 (synopsis "Sphinx extension for rendering HTML help files")
72f278a0
MB
187 (description
188 "@code{sphinxcontrib-htmlhelp} is a Sphinx extension which renders
189HTML help files.")
190 (license license:bsd-2)))
191
67be8943
MB
192(define-public python-sphinxcontrib-jsmath
193 (package
194 (name "python-sphinxcontrib-jsmath")
195 (version "1.0.1")
196 (source (origin
197 (method url-fetch)
198 (uri (pypi-uri "sphinxcontrib-jsmath" version))
199 (sha256
200 (base32
201 "1f64w19j33sp151jimibraw6qrbhd5gxy8hs3797w9478m55x4m9"))))
202 (build-system python-build-system)
203 (arguments
204 `(#:tests? #f)) ;XXX: circular dependency on Sphinx
205 (home-page "https://github.com/sphinx-doc/sphinxcontrib-jsmath")
206 (synopsis "Sphinx extension to render math equations")
207 (description
208 "@code{sphinxcontrib-jsmath} is a Sphinx extension which renders display
209math in HTML via JavaScript.")
774520df 210 (license license:bsd-2)))
67be8943 211
9d0c291e
MB
212(define-public python-sphinxcontrib-newsfeed
213 (package
214 (name "python-sphinxcontrib-newsfeed")
215 (version "0.1.4")
216 (source (origin
217 (method url-fetch)
218 (uri (pypi-uri "sphinxcontrib-newsfeed" version))
219 (sha256
220 (base32
221 "1d7gam3mn8v4in4p16yn3v10vps7nnaz6ilw99j4klij39dqd37p"))))
222 (arguments '(#:tests? #f)) ; No tests.
223 (build-system python-build-system)
224 (propagated-inputs
225 `(("python-sphinx" ,python-sphinx)))
226 (synopsis "News Feed extension for Sphinx")
227 (description "Sphinxcontrib-newsfeed is an extension for adding a simple
228Blog, News or Announcements section to a Sphinx website.")
229 (home-page "https://bitbucket.org/prometheus/sphinxcontrib-newsfeed")
230 (license license:bsd-2)))
231
232(define-public python-sphinxcontrib-programoutput
233 (package
234 (name "python-sphinxcontrib-programoutput")
e2734fec 235 (version "0.15")
9d0c291e
MB
236 (source (origin
237 (method url-fetch)
238 (uri (pypi-uri "sphinxcontrib-programoutput" version))
239 (sha256
240 (base32
e2734fec 241 "155bz0z2cz544pphkd3nk7ph83mz7nn0ql135kzi62kqmd75ppc0"))))
9d0c291e
MB
242 (build-system python-build-system)
243 (arguments
b45aafd5 244 ;; FIXME: Many tests are failing.
9d0c291e
MB
245 '(#:tests? #f))
246 (propagated-inputs
247 `(("python-sphinx" ,python-sphinx)))
248 (synopsis "Sphinx extension to include program output")
249 (description "A Sphinx extension to literally insert the output of arbitrary
250commands into documents, helping you to keep your command examples up to date.")
b45aafd5 251 (home-page "https://github.com/NextThought/sphinxcontrib-programoutput")
9d0c291e
MB
252 (license license:bsd-2)))
253
254(define-public python2-sphinxcontrib-programoutput
255 (package-with-python2 python-sphinxcontrib-programoutput))
256
6eceb2d4
MB
257(define-public python-sphinxcontrib-qthelp
258 (package
259 (name "python-sphinxcontrib-qthelp")
99533beb 260 (version "1.0.3")
6eceb2d4
MB
261 (source (origin
262 (method url-fetch)
263 (uri (pypi-uri "sphinxcontrib-qthelp" version))
264 (sha256
265 (base32
99533beb 266 "0wjsp96d262shzkx7pb7pra7mmf0j8c5rz56i6x0vdsqw1z7ccsc"))))
6eceb2d4
MB
267 (build-system python-build-system)
268 (arguments
269 `(#:tests? #f)) ;XXX: circular dependency on Sphinx
270 (home-page "https://github.com/sphinx-doc/sphinxcontrib-qthelp")
271 (synopsis "Sphinx extension to output QtHelp documents")
272 (description
273 "@code{sphinxcontrib-qthelp} is a Sphinx extension which outputs QtHelp
274documents.")
275 (license license:bsd-2)))
276
c5c55a9f
MB
277(define-public python-sphinxcontrib-serializinghtml
278 (package
279 (name "python-sphinxcontrib-serializinghtml")
11be1573 280 (version "1.1.4")
c5c55a9f
MB
281 (source (origin
282 (method url-fetch)
283 (uri (pypi-uri "sphinxcontrib-serializinghtml" version))
284 (sha256
285 (base32
11be1573 286 "1g3pbx0g88zd9xzcrbaypa2k60axrh92vf5j76wsk0p9hv6fr87a"))))
c5c55a9f
MB
287 (build-system python-build-system)
288 (arguments
289 `(#:tests? #f)) ;XXX: circular dependency on Sphinx
290 (home-page "https://github.com/sphinx-doc/sphinxcontrib-serializinghtml")
291 (synopsis "Sphinx extension to serialize HTML files")
292 (description
293 "@code{sphinxcontrib-serializinghtml} is a Sphinx extension which outputs
294\"serialized\" HTML files.")
295 (license license:bsd-2)))
296
9d0c291e
MB
297(define-public python-sphinxcontrib-svg2pdfconverter
298 (package
299 (name "python-sphinxcontrib-svg2pdfconverter")
76c83e33 300 (version "1.0.1")
9d0c291e
MB
301 (source (origin
302 (method url-fetch)
303 (uri (pypi-uri "sphinxcontrib-svg2pdfconverter" version))
304 (sha256
305 (base32
76c83e33 306 "1hhaxmqc7wh8gnyw5jaqckliknvk0p21y12wk3bdmncgkaf9ar8f"))))
9d0c291e
MB
307 (build-system python-build-system)
308 (propagated-inputs
309 `(("python-sphinx" ,python-sphinx)))
2564081c 310 (home-page "https://github.com/missinglinkelectronics/sphinxcontrib-svg2pdfconverter")
9d0c291e 311 (synopsis "Sphinx SVG to PDF converter extension")
f80d3442
BG
312 (description "A Sphinx extension to convert SVG images to PDF in case the
313builder does not support SVG images natively (e.g. LaTeX).")
f3c00bd1 314 (license license:bsd-2)))
9d0c291e
MB
315
316(define-public python-sphinxcontrib-websupport
317 (package
318 (name "python-sphinxcontrib-websupport")
18d59640 319 (version "1.2.0")
9d0c291e
MB
320 (source (origin
321 (method url-fetch)
322 (uri (pypi-uri "sphinxcontrib-websupport" version))
323 (sha256
324 (base32
18d59640 325 "1smma7r0rhwcmbfvvkfs5djfz1qm8wbpcvp084ca6dmw2b9zplxs"))))
9d0c291e
MB
326 (build-system python-build-system)
327 (arguments
328 ;; FIXME: Tests depend on Sphinx, which depends on this.
329 `(#:tests? #f))
b549a053 330 (home-page "https://sphinx-doc.org/")
9d0c291e
MB
331 (synopsis "Sphinx API for web applications")
332 (description "This package provides a Python API to easily integrate
333Sphinx documentation into your web application. It provides tools to
334integrate Sphinx documents in web templates and to handle searches.")
335 (license license:bsd-3)))
336
337(define-public python2-sphinxcontrib-websupport
338 (package-with-python2 python-sphinxcontrib-websupport))
339
340(define-public python-sphinx-gallery
341 (package
342 (name "python-sphinx-gallery")
343 (version "0.1.13")
344 (source (origin
d090a1c1
EF
345 (method git-fetch)
346 (uri (git-reference
347 (url "https://github.com/sphinx-gallery/sphinx-gallery")
348 (commit (string-append "v" version))))
349 (file-name (git-file-name name version))
9d0c291e
MB
350 (sha256
351 (base32
d090a1c1 352 "14nbqh9krx2l2y2ylbln6l6w8iak3wac1lngvaf278y1cx7685kg"))))
9d0c291e
MB
353 (build-system python-build-system)
354 (arguments
355 ;; FIXME: Tests attempt to download <https://docs.python.org/3/objects.inv>,
356 ;; <https://docs.scipy.org/doc/numpy/objects.inv>, and
357 ;; <https://matplotlib.org/objects.inv>.
358 `(#:tests? #f))
359 (native-inputs
360 `(("python-pytest-runner" ,python-pytest-runner)))
361 (home-page "https://sphinx-gallery.github.io/")
362 (synopsis "Generate an examples gallery automatically")
363 (description
364 "@code{sphinx_gallery} is a Sphinx extension that builds an HTML version
365from any set of Python scripts and puts it into an examples gallery.")
366 (license license:bsd-3)))
367
368(define-public python2-sphinx-gallery
369 (package-with-python2 python-sphinx-gallery))
370
371(define-public python-sphinx-me
372 (package
373 (name "python-sphinx-me")
374 (version "0.3")
375 (source
376 (origin
377 (method url-fetch)
378 (uri (pypi-uri "sphinx-me" version))
379 (sha256
380 (base32
381 "06jzgp213zihnvpcy2y5jy3ykid3apc2ncp2pg6a2g05lhiziglq"))))
382 (build-system python-build-system)
383 (home-page "https://github.com/stephenmcd/sphinx-me")
384 (synopsis "Create a Sphinx documentation shell")
385 (description
386 "Create a Sphinx documentation shell for your project and include the
387README file as the documentation index. It handles extracting the required
388meta data such as the project name, author and version from your project for
389use in your Sphinx docs.")
390 (license license:bsd-2)))
391
392(define-public python2-sphinx-me
393 (package-with-python2 python-sphinx-me))
394
395(define-public python-sphinx-repoze-autointerface
396 (package
397 (name "python-sphinx-repoze-autointerface")
398 (version "0.8")
399 (source (origin
400 (method url-fetch)
401 (uri (pypi-uri "repoze.sphinx.autointerface" version))
402 (sha256
403 (base32
404 "08ycivzf7bh4a1zcyp31hbyqs1b2c9r26raa3vxjwwmbfqr3iw4f"))))
405 (build-system python-build-system)
406 (arguments '(#:tests? #f)) ; No tests.
407 (propagated-inputs
408 `(("python-sphinx" ,python-sphinx)
409 ("python-zope-interface" ,python-zope-interface)))
410 (synopsis "Auto-generate Sphinx API docs from Zope interfaces")
411 (description "This package defines an extension for the Sphinx documentation
412system. The extension allows generation of API documentation by
413introspection of @code{zope.interface} instances in code.")
414 (home-page "https://github.com/repoze/repoze.sphinx.autointerface")
415 (license license:repoze)))
416
417(define-public python2-sphinx-repoze-autointerface
418 (package-with-python2 python-sphinx-repoze-autointerface))
419
420(define-public python-sphinx-alabaster-theme
421 (package
422 (name "python-sphinx-alabaster-theme")
423 (version "0.7.12")
424 (source (origin
425 (method url-fetch)
426 (uri (pypi-uri "alabaster" version))
427 (sha256
428 (base32
429 "00nwwjj2d2ym4s2kk217x7jkx1hnczc3fvm8yxbqmsp6b0nxfqd6"))))
430 (build-system python-build-system)
431 (propagated-inputs
432 `(("python-pygments" ,python-pygments)))
433 (home-page "https://alabaster.readthedocs.io/")
434 (synopsis "Configurable sidebar-enabled Sphinx theme")
435 (description "Alabaster is a visually (c)lean, responsive, configurable
436theme for the Sphinx documentation system. It's the default theme of Sphinx.")
437 (license license:bsd-3)))
438
439(define-public python2-sphinx-alabaster-theme
440 (package-with-python2 python-sphinx-alabaster-theme))
441
442(define-public python-sphinx-cloud-sptheme
443 (package
444 (name "python-sphinx-cloud-sptheme")
445 (version "1.8.0")
446 (source (origin
447 (method url-fetch)
448 (uri (pypi-uri "cloud_sptheme" version))
449 (sha256
450 (base32
451 "1dniqb6a39yh786f86c4jn666rwnyi1jvzn4616zhcchb7sfdshd"))))
452 (build-system python-build-system)
453 ;; FIXME: The 'pypi' release archive does not contain tests.
454 (arguments '(#:tests? #f))
455 (native-inputs
456 `(("python-sphinx" ,python-sphinx)))
457 (home-page "https://bitbucket.org/ecollins/cloud_sptheme")
458 (synopsis "'Cloud' theme for Sphinx documenter")
459 (description "This package contains the \"Cloud\" theme for Sphinx and some
460related extensions.")
461 (license license:bsd-3)))
462
463(define-public python2-sphinx-cloud-sptheme
464 (package-with-python2 python-sphinx-cloud-sptheme))
465
466(define-public python-guzzle-sphinx-theme
467 (package
468 (name "python-guzzle-sphinx-theme")
469 (version "0.7.11")
470 (source
471 (origin
472 (method url-fetch)
473 (uri (pypi-uri "guzzle_sphinx_theme" version))
474 (sha256
475 (base32
476 "1rnkzrrsbnifn3vsb4pfaia3nlvgvw6ndpxp7lzjrh23qcwid34v"))))
477 (build-system python-build-system)
478 (propagated-inputs
479 `(("python-sphinx" ,python-sphinx)))
480 (home-page "https://github.com/guzzle/guzzle_sphinx_theme")
481 (synopsis "Sphinx theme used by Guzzle")
482 (description "This package provides guzzle_sphinx_theme, a theme for the
483Sphinx documentation system, used by @uref{http://docs.guzzlephp.org, Guzzle}
484and several other projects.")
485 (license license:expat)))
486
487(define-public python2-guzzle-sphinx-theme
488 (package-with-python2 python-guzzle-sphinx-theme))
489
490(define-public python-sphinx-rtd-theme
491 (package
492 (name "python-sphinx-rtd-theme")
493 (version "0.2.4")
494 (source
495 (origin
496 (method url-fetch)
497 (uri (pypi-uri "sphinx_rtd_theme" version))
498 (sha256
499 (base32
500 "05rlhjzdyapr2w74jjs7mrm8hi69qskcr5vya9f9drpsys7lpxrd"))))
501 (build-system python-build-system)
502 (arguments '(#:tests? #f)) ; No tests.
503 (propagated-inputs
504 `(("python-sphinx" ,python-sphinx)))
505 (home-page "https://github.com/snide/sphinx_rtd_theme/")
506 (synopsis "ReadTheDocs.org theme for Sphinx")
507 (description "A theme for Sphinx used by ReadTheDocs.org.")
508 (license license:expat)))
509
510(define-public python2-sphinx-rtd-theme
511 (package-with-python2 python-sphinx-rtd-theme))
68f0de01
SB
512
513(define-public python-breathe
514 (package
515 (name "python-breathe")
dd7cdd3d 516 (version "4.22.1")
68f0de01
SB
517 (source
518 (origin
519 (method url-fetch)
520 (uri (pypi-uri "breathe" version))
521 (sha256
522 (base32
dd7cdd3d 523 "0snk538xv60z4vfhl3f7v5g658za7257hddkg07cknkn33k6cjvf"))))
68f0de01
SB
524 (build-system python-build-system)
525 (propagated-inputs
526 `(("python-docutils" ,python-docutils)
527 ("python-six" ,python-six)
528 ("python-sphinx" ,python-sphinx)))
529 (home-page "https://github.com/michaeljones/breathe")
530 (synopsis "ReStructuredText and Sphinx bridge to Doxygen")
531 (description "This package is an extension to reStructuredText and Sphinx
532to be able to read and render the Doxygen xml output.")
533 (license license:bsd-3)))
90ee17cd
AT
534
535(define-public python-sphinx-intl
536 (package
537 (name "python-sphinx-intl")
728fdd83 538 (version "2.0.1")
90ee17cd
AT
539 (source
540 (origin
541 (method url-fetch)
542 (uri (pypi-uri "sphinx-intl" version))
543 (sha256
728fdd83 544 (base32 "1d1q0sanjp4nkfvhsxi75zf3xjyyi8nzxvl3v7l0jy9ld70nwnmj"))))
90ee17cd
AT
545 (build-system python-build-system)
546 (propagated-inputs
547 `(("python-sphinx" ,python-sphinx)
548 ("python-click" ,python-click)))
549 (home-page "https://github.com/sphinx-doc/sphinx-intl")
550 (synopsis
551 "Sphinx utility that makes it easy to translate and to apply translation")
552 (description
553 "A utility tool that provides several features that make it easy to
554translate and to apply translation to Sphinx generated document.")
555 (license license:bsd-2)))
e9f93cd5
RW
556
557(define-public python-sphinx-autobuild
558 (package
559 (name "python-sphinx-autobuild")
560 (version "0.7.1")
561 (source
562 (origin
563 (method url-fetch)
564 (uri (pypi-uri "sphinx-autobuild" version))
565 (sha256
566 (base32
567 "0kn753dyh3b1s0h77lbk704niyqc7bamvq6v3s1f6rj6i20qyf36"))))
568 (build-system python-build-system)
569 (arguments
570 `(#:phases
571 (modify-phases %standard-phases
572 ;; See https://github.com/GaretJax/sphinx-autobuild/pull/72
573 (add-after 'unpack 'use-later-port-for
574 (lambda _
575 (substitute* "requirements.txt"
576 (("port_for==.*") "port_for\n"))
577 #t))
578 (delete 'check)
579 (add-after 'install 'check
580 (lambda* (#:key inputs outputs tests? #:allow-other-keys)
581 (when tests?
582 (add-installed-pythonpath inputs outputs)
583 (invoke "pytest" "-v"))
584 #t)))))
585 (propagated-inputs
586 `(("python-argh" ,python-argh)
587 ("python-livereload" ,python-livereload)
588 ("python-pathtools" ,python-pathtools)
589 ("python-port-for" ,python-port-for)
590 ("python-pyyaml" ,python-pyyaml)
591 ("python-tornado" ,python-tornado)
592 ("python-watchdog" ,python-watchdog)))
593 (native-inputs
594 `(("python-pytest" ,python-pytest)))
595 (home-page "https://github.com/GaretJax/sphinx-autobuild")
596 (synopsis "Rebuild Sphinx documentation when a change is detected")
597 (description
598 "This package lets you watch a Sphinx directory and rebuild the
599documentation when a change is detected. It also includes a livereload
600enabled web server.")
601 (license license:expat)))
83ade5bf
GL
602
603(define-public python-nbsphinx
604 (package
605 (name "python-nbsphinx")
606 (version "0.7.1")
607 (source
608 (origin
609 (method url-fetch)
610 (uri (pypi-uri "nbsphinx" version))
611 (sha256
612 (base32
613 "0j56bxdj08vn3q1804qwb1ywhga1mdg1awgm7i64wfpfwi8df2zm"))))
614 (build-system python-build-system)
615 (propagated-inputs
616 `(("python-docutils" ,python-docutils)
617 ("python-jinja2" ,python-jinja2)
618 ("python-nbconvert" ,python-nbconvert)
619 ("python-nbformat" ,python-nbformat)
620 ("python-sphinx" ,python-sphinx)
621 ("python-traitlets" ,python-traitlets)))
622 (home-page "https://nbsphinx.readthedocs.io/")
623 (synopsis "Jupyter Notebook Tools for Sphinx")
624 (description "@code{python-nbsphinx} is a Sphinx extension that
625provides a source parser for @code{*.ipynb} files. Custom Sphinx
626directives are used to show Jupyter Notebook code cells (and of course
627their results) in both HTML and LaTeX output. Un-evaluated notebooks
628- i.e. notebooks without stored output cells - will be automatically
629executed during the Sphinx build process.")
630 (license license:expat)))