1 ;;; GNU Guix --- Functional package management for GNU
2 ;;; Copyright © 2014 David Thompson <davet@gnu.org>
3 ;;; Copyright © 2015, 2017, 2019, 2020 Ricardo Wurmus <rekado@elephly.net>
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>
8 ;;; Copyright © 2017, 2018, 2020 Tobias Geerinckx-Rice <me@tobias.gr>
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>
14 ;;; Copyright © 2019 Alexandros Theodotou <alex@zrythm.org>
15 ;;; Copyright © 2019 Brett Gilio <brettg@gnu.org>
16 ;;; Copyright © 2020 Giacomo Leidi <goodoldpaul@autistici.org>
18 ;;; This file is part of GNU Guix.
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.
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.
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/>.
33 (define-module (gnu packages sphinx)
34 #:use-module (guix packages)
35 #:use-module (guix download)
36 #:use-module (guix git-download)
37 #:use-module (guix utils)
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)
45 #:use-module (gnu packages python-web)
46 #:use-module (gnu packages python-xyz)
47 #:use-module (gnu packages time))
49 (define-public python-sphinx
51 (name "python-sphinx")
56 (uri (pypi-uri "Sphinx" version))
59 "0023vc2i29pjxmvdqbz1wdbi7gbj56y1br1b2z8h8wa44li5k38y"))))
60 (build-system python-build-system)
63 (modify-phases %standard-phases
66 ;; Requires Internet access.
67 (delete-file "tests/test_build_linkcheck.py")
68 (substitute* "tests/test_build_latex.py"
69 (("@pytest.mark.sphinx\\('latex', testroot='images'\\)")
70 "@pytest.mark.skip()"))
71 (invoke "make" "test"))))))
73 `(("python-babel" ,python-babel)
74 ("python-docutils" ,python-docutils)
75 ("python-jinja2" ,python-jinja2)
76 ("python-imagesize" ,python-imagesize)
77 ("python-packaging" ,python-packaging)
78 ("python-pygments" ,python-pygments)
79 ("python-requests" ,python-requests)
80 ("python-snowballstemmer" ,python-snowballstemmer)
81 ("python-sphinx-alabaster-theme"
82 ,python-sphinx-alabaster-theme)
83 ("python-sphinxcontrib-applehelp" ,python-sphinxcontrib-applehelp)
84 ("python-sphinxcontrib-devhelp" ,python-sphinxcontrib-devhelp)
85 ("python-sphinxcontrib-htmlhelp" ,python-sphinxcontrib-htmlhelp)
86 ("python-sphinxcontrib-jsmath" ,python-sphinxcontrib-jsmath)
87 ("python-sphinxcontrib-qthelp" ,python-sphinxcontrib-qthelp)
88 ("python-sphinxcontrib-serializinghtml"
89 ,python-sphinxcontrib-serializinghtml)))
91 `(("graphviz" ,graphviz)
92 ("imagemagick" ,imagemagick) ;for "convert"
93 ("python-html5lib" ,python-html5lib)
94 ("python-mock" ,python-mock)
95 ("python-nose" ,python-nose)
96 ("python-pytest" ,python-pytest)))
97 (home-page "https://www.sphinx-doc.org")
98 (synopsis "Python documentation generator")
99 (description "Sphinx is a tool that makes it easy to create documentation
100 for Python projects or other documents consisting of multiple reStructuredText
102 (license license:bsd-2)
103 (properties `((python2-variant . ,(delay python-sphinx))))))
105 (define-public python-sphinxcontrib-applehelp
107 (name "python-sphinxcontrib-applehelp")
111 (uri (pypi-uri "sphinxcontrib-applehelp" version))
114 "0n5wrn4l7x6gxvi1g7c6y72hkxgc223axz1jykipaxhfr1g76wm0"))))
115 (build-system python-build-system)
117 `(#:tests? #f)) ;XXX: circular dependency on Sphinx
118 (home-page "https://github.com/sphinx-doc/sphinxcontrib-applehelp")
119 (synopsis "Sphinx extension for creating Apple help books")
121 "@code{sphinxcontrib-applehelp} is a Sphinx extension which outputs
123 (license license:bsd-2)))
125 (define-public python-sphinx-copybutton
127 (name "python-sphinx-copybutton")
132 (uri (pypi-uri "sphinx-copybutton" version))
135 "0ny9jpygj93z8jyjpi4v6jjz90pmns74s389wq16igzzq2mpgfjm"))))
136 (build-system python-build-system)
138 `(#:tests? #f)) ; XXX: Check requires network access.
140 `(("python-flit" ,python-flit)
141 ("python-setuptools" ,python-setuptools)
142 ("python-sphinx" ,python-sphinx)
143 ("python-wheel" ,python-wheel)))
144 (home-page "https://github.com/choldgraf/sphinx-copybutton")
145 (synopsis "Sphinx extension to add \"copy\" buttons to code blocks")
147 "This package provides a small sphinx extension to add \"copy\" buttons
149 (license license:expat)))
151 (define-public python-sphinxcontrib-devhelp
153 (name "python-sphinxcontrib-devhelp")
157 (uri (pypi-uri "sphinxcontrib-devhelp" version))
160 "1r1qngsbjqbg4rj93kpj44qqy7n4x5khldkr0c3ffhlnggx1lzzz"))))
161 (build-system python-build-system)
163 `(#:tests? #f)) ;XXX: circular dependency on Sphinx
164 (home-page "https://github.com/sphinx-doc/sphinxcontrib-devhelp")
165 (synopsis "Sphinx extension for creating Devhelp documents")
167 "@code{sphinxcontrib-devhelp} is a Sphinx extension which outputs
168 @url{Devhelp,https://wiki.gnome.org/Apps/Devhelp} documents.")
169 (license license:bsd-2)))
171 (define-public python-sphinxcontrib-htmlhelp
173 (name "python-sphinxcontrib-htmlhelp")
177 (uri (pypi-uri "sphinxcontrib-htmlhelp" version))
180 "16v5jdnibwrqjdr5aqchgyzpwy3rgamwhdf4kidv5nxj65zbpxg8"))))
181 (build-system python-build-system)
183 `(#:tests? #f)) ;XXX: circular dependency on Sphinx
184 (home-page "https://github.com/sphinx-doc/sphinxcontrib-htmlhelp")
185 (synopsis "Sphinx extension for rendering HTML help files")
187 "@code{sphinxcontrib-htmlhelp} is a Sphinx extension which renders
189 (license license:bsd-2)))
191 (define-public python-sphinxcontrib-jsmath
193 (name "python-sphinxcontrib-jsmath")
197 (uri (pypi-uri "sphinxcontrib-jsmath" version))
200 "1f64w19j33sp151jimibraw6qrbhd5gxy8hs3797w9478m55x4m9"))))
201 (build-system python-build-system)
203 `(#:tests? #f)) ;XXX: circular dependency on Sphinx
204 (home-page "https://github.com/sphinx-doc/sphinxcontrib-jsmath")
205 (synopsis "Sphinx extension to render math equations")
207 "@code{sphinxcontrib-jsmath} is a Sphinx extension which renders display
208 math in HTML via JavaScript.")
209 (license license:bsd-2)))
211 (define-public python-sphinxcontrib-newsfeed
213 (name "python-sphinxcontrib-newsfeed")
217 (uri (pypi-uri "sphinxcontrib-newsfeed" version))
220 "1d7gam3mn8v4in4p16yn3v10vps7nnaz6ilw99j4klij39dqd37p"))))
221 (arguments '(#:tests? #f)) ; No tests.
222 (build-system python-build-system)
224 `(("python-sphinx" ,python-sphinx)))
225 (synopsis "News Feed extension for Sphinx")
226 (description "Sphinxcontrib-newsfeed is an extension for adding a simple
227 Blog, News or Announcements section to a Sphinx website.")
228 (home-page "https://bitbucket.org/prometheus/sphinxcontrib-newsfeed")
229 (license license:bsd-2)))
231 (define-public python-sphinxcontrib-programoutput
233 (name "python-sphinxcontrib-programoutput")
237 (uri (pypi-uri "sphinxcontrib-programoutput" version))
240 "155bz0z2cz544pphkd3nk7ph83mz7nn0ql135kzi62kqmd75ppc0"))))
241 (build-system python-build-system)
243 ;; FIXME: Many tests are failing.
246 `(("python-sphinx" ,python-sphinx)))
247 (synopsis "Sphinx extension to include program output")
248 (description "A Sphinx extension to literally insert the output of arbitrary
249 commands into documents, helping you to keep your command examples up to date.")
250 (home-page "https://github.com/NextThought/sphinxcontrib-programoutput")
251 (license license:bsd-2)))
253 (define-public python2-sphinxcontrib-programoutput
254 (package-with-python2 python-sphinxcontrib-programoutput))
256 (define-public python-sphinxcontrib-qthelp
258 (name "python-sphinxcontrib-qthelp")
262 (uri (pypi-uri "sphinxcontrib-qthelp" version))
265 "0wjsp96d262shzkx7pb7pra7mmf0j8c5rz56i6x0vdsqw1z7ccsc"))))
266 (build-system python-build-system)
268 `(#:tests? #f)) ;XXX: circular dependency on Sphinx
269 (home-page "https://github.com/sphinx-doc/sphinxcontrib-qthelp")
270 (synopsis "Sphinx extension to output QtHelp documents")
272 "@code{sphinxcontrib-qthelp} is a Sphinx extension which outputs QtHelp
274 (license license:bsd-2)))
276 (define-public python-sphinxcontrib-serializinghtml
278 (name "python-sphinxcontrib-serializinghtml")
282 (uri (pypi-uri "sphinxcontrib-serializinghtml" version))
285 "1g3pbx0g88zd9xzcrbaypa2k60axrh92vf5j76wsk0p9hv6fr87a"))))
286 (build-system python-build-system)
288 `(#:tests? #f)) ;XXX: circular dependency on Sphinx
289 (home-page "https://github.com/sphinx-doc/sphinxcontrib-serializinghtml")
290 (synopsis "Sphinx extension to serialize HTML files")
292 "@code{sphinxcontrib-serializinghtml} is a Sphinx extension which outputs
293 \"serialized\" HTML files.")
294 (license license:bsd-2)))
296 (define-public python-sphinxcontrib-svg2pdfconverter
298 (name "python-sphinxcontrib-svg2pdfconverter")
302 (uri (pypi-uri "sphinxcontrib-svg2pdfconverter" version))
305 "1hhaxmqc7wh8gnyw5jaqckliknvk0p21y12wk3bdmncgkaf9ar8f"))))
306 (build-system python-build-system)
308 `(("python-sphinx" ,python-sphinx)))
309 (home-page "https://github.com/missinglinkelectronics/sphinxcontrib-svg2pdfconverter")
310 (synopsis "Sphinx SVG to PDF converter extension")
311 (description "A Sphinx extension to convert SVG images to PDF in case the
312 builder does not support SVG images natively (e.g. LaTeX).")
313 (license license:bsd-2)))
315 (define-public python-sphinxcontrib-websupport
317 (name "python-sphinxcontrib-websupport")
321 (uri (pypi-uri "sphinxcontrib-websupport" version))
324 "1smma7r0rhwcmbfvvkfs5djfz1qm8wbpcvp084ca6dmw2b9zplxs"))))
325 (build-system python-build-system)
327 ;; FIXME: Tests depend on Sphinx, which depends on this.
329 (home-page "https://sphinx-doc.org/")
330 (synopsis "Sphinx API for web applications")
331 (description "This package provides a Python API to easily integrate
332 Sphinx documentation into your web application. It provides tools to
333 integrate Sphinx documents in web templates and to handle searches.")
334 (license license:bsd-3)))
336 (define-public python2-sphinxcontrib-websupport
337 (package-with-python2 python-sphinxcontrib-websupport))
339 (define-public python-sphinx-gallery
341 (name "python-sphinx-gallery")
346 (url "https://github.com/sphinx-gallery/sphinx-gallery")
347 (commit (string-append "v" version))))
348 (file-name (git-file-name name version))
351 "14nbqh9krx2l2y2ylbln6l6w8iak3wac1lngvaf278y1cx7685kg"))))
352 (build-system python-build-system)
354 ;; FIXME: Tests attempt to download <https://docs.python.org/3/objects.inv>,
355 ;; <https://docs.scipy.org/doc/numpy/objects.inv>, and
356 ;; <https://matplotlib.org/objects.inv>.
359 `(("python-pytest-runner" ,python-pytest-runner)))
360 (home-page "https://sphinx-gallery.github.io/")
361 (synopsis "Generate an examples gallery automatically")
363 "@code{sphinx_gallery} is a Sphinx extension that builds an HTML version
364 from any set of Python scripts and puts it into an examples gallery.")
365 (license license:bsd-3)))
367 (define-public python2-sphinx-gallery
368 (package-with-python2 python-sphinx-gallery))
370 (define-public python-sphinx-me
372 (name "python-sphinx-me")
377 (uri (pypi-uri "sphinx-me" version))
380 "06jzgp213zihnvpcy2y5jy3ykid3apc2ncp2pg6a2g05lhiziglq"))))
381 (build-system python-build-system)
382 (home-page "https://github.com/stephenmcd/sphinx-me")
383 (synopsis "Create a Sphinx documentation shell")
385 "Create a Sphinx documentation shell for your project and include the
386 README file as the documentation index. It handles extracting the required
387 meta data such as the project name, author and version from your project for
388 use in your Sphinx docs.")
389 (license license:bsd-2)))
391 (define-public python2-sphinx-me
392 (package-with-python2 python-sphinx-me))
394 (define-public python-sphinx-repoze-autointerface
396 (name "python-sphinx-repoze-autointerface")
400 (uri (pypi-uri "repoze.sphinx.autointerface" version))
403 "08ycivzf7bh4a1zcyp31hbyqs1b2c9r26raa3vxjwwmbfqr3iw4f"))))
404 (build-system python-build-system)
405 (arguments '(#:tests? #f)) ; No tests.
407 `(("python-sphinx" ,python-sphinx)
408 ("python-zope-interface" ,python-zope-interface)))
409 (synopsis "Auto-generate Sphinx API docs from Zope interfaces")
410 (description "This package defines an extension for the Sphinx documentation
411 system. The extension allows generation of API documentation by
412 introspection of @code{zope.interface} instances in code.")
413 (home-page "https://github.com/repoze/repoze.sphinx.autointerface")
414 (license license:repoze)))
416 (define-public python2-sphinx-repoze-autointerface
417 (package-with-python2 python-sphinx-repoze-autointerface))
419 (define-public python-sphinx-alabaster-theme
421 (name "python-sphinx-alabaster-theme")
425 (uri (pypi-uri "alabaster" version))
428 "00nwwjj2d2ym4s2kk217x7jkx1hnczc3fvm8yxbqmsp6b0nxfqd6"))))
429 (build-system python-build-system)
431 `(("python-pygments" ,python-pygments)))
432 (home-page "https://alabaster.readthedocs.io/")
433 (synopsis "Configurable sidebar-enabled Sphinx theme")
434 (description "Alabaster is a visually (c)lean, responsive, configurable
435 theme for the Sphinx documentation system. It's the default theme of Sphinx.")
436 (license license:bsd-3)))
438 (define-public python2-sphinx-alabaster-theme
439 (package-with-python2 python-sphinx-alabaster-theme))
441 (define-public python-sphinx-cloud-sptheme
443 (name "python-sphinx-cloud-sptheme")
447 (uri (pypi-uri "cloud_sptheme" version))
450 "1dniqb6a39yh786f86c4jn666rwnyi1jvzn4616zhcchb7sfdshd"))))
451 (build-system python-build-system)
452 ;; FIXME: The 'pypi' release archive does not contain tests.
453 (arguments '(#:tests? #f))
455 `(("python-sphinx" ,python-sphinx)))
456 (home-page "https://bitbucket.org/ecollins/cloud_sptheme")
457 (synopsis "'Cloud' theme for Sphinx documenter")
458 (description "This package contains the \"Cloud\" theme for Sphinx and some
459 related extensions.")
460 (license license:bsd-3)))
462 (define-public python2-sphinx-cloud-sptheme
463 (package-with-python2 python-sphinx-cloud-sptheme))
465 (define-public python-guzzle-sphinx-theme
467 (name "python-guzzle-sphinx-theme")
472 (uri (pypi-uri "guzzle_sphinx_theme" version))
475 "1rnkzrrsbnifn3vsb4pfaia3nlvgvw6ndpxp7lzjrh23qcwid34v"))))
476 (build-system python-build-system)
478 `(("python-sphinx" ,python-sphinx)))
479 (home-page "https://github.com/guzzle/guzzle_sphinx_theme")
480 (synopsis "Sphinx theme used by Guzzle")
481 (description "This package provides guzzle_sphinx_theme, a theme for the
482 Sphinx documentation system, used by @uref{http://docs.guzzlephp.org, Guzzle}
483 and several other projects.")
484 (license license:expat)))
486 (define-public python2-guzzle-sphinx-theme
487 (package-with-python2 python-guzzle-sphinx-theme))
489 (define-public python-sphinx-rtd-theme
491 (name "python-sphinx-rtd-theme")
496 (uri (pypi-uri "sphinx_rtd_theme" version))
499 "05rlhjzdyapr2w74jjs7mrm8hi69qskcr5vya9f9drpsys7lpxrd"))))
500 (build-system python-build-system)
501 (arguments '(#:tests? #f)) ; No tests.
503 `(("python-sphinx" ,python-sphinx)))
504 (home-page "https://github.com/snide/sphinx_rtd_theme/")
505 (synopsis "ReadTheDocs.org theme for Sphinx")
506 (description "A theme for Sphinx used by ReadTheDocs.org.")
507 (license license:expat)))
509 (define-public python2-sphinx-rtd-theme
510 (package-with-python2 python-sphinx-rtd-theme))
512 (define-public python-breathe
514 (name "python-breathe")
519 (uri (pypi-uri "breathe" version))
522 "0snk538xv60z4vfhl3f7v5g658za7257hddkg07cknkn33k6cjvf"))))
523 (build-system python-build-system)
525 `(("python-docutils" ,python-docutils)
526 ("python-six" ,python-six)
527 ("python-sphinx" ,python-sphinx)))
528 (home-page "https://github.com/michaeljones/breathe")
529 (synopsis "ReStructuredText and Sphinx bridge to Doxygen")
530 (description "This package is an extension to reStructuredText and Sphinx
531 to be able to read and render the Doxygen xml output.")
532 (license license:bsd-3)))
534 (define-public python-sphinx-intl
536 (name "python-sphinx-intl")
541 (uri (pypi-uri "sphinx-intl" version))
543 (base32 "1d1q0sanjp4nkfvhsxi75zf3xjyyi8nzxvl3v7l0jy9ld70nwnmj"))))
544 (build-system python-build-system)
546 `(("python-sphinx" ,python-sphinx)
547 ("python-click" ,python-click)))
548 (home-page "https://github.com/sphinx-doc/sphinx-intl")
550 "Sphinx utility that makes it easy to translate and to apply translation")
552 "A utility tool that provides several features that make it easy to
553 translate and to apply translation to Sphinx generated document.")
554 (license license:bsd-2)))
556 (define-public python-sphinx-autobuild
558 (name "python-sphinx-autobuild")
563 (uri (pypi-uri "sphinx-autobuild" version))
566 "0kn753dyh3b1s0h77lbk704niyqc7bamvq6v3s1f6rj6i20qyf36"))))
567 (build-system python-build-system)
570 (modify-phases %standard-phases
571 ;; See https://github.com/GaretJax/sphinx-autobuild/pull/72
572 (add-after 'unpack 'use-later-port-for
574 (substitute* "requirements.txt"
575 (("port_for==.*") "port_for\n"))
578 (add-after 'install 'check
579 (lambda* (#:key inputs outputs tests? #:allow-other-keys)
581 (add-installed-pythonpath inputs outputs)
582 (invoke "pytest" "-v"))
585 `(("python-argh" ,python-argh)
586 ("python-livereload" ,python-livereload)
587 ("python-pathtools" ,python-pathtools)
588 ("python-port-for" ,python-port-for)
589 ("python-pyyaml" ,python-pyyaml)
590 ("python-tornado" ,python-tornado)
591 ("python-watchdog" ,python-watchdog)))
593 `(("python-pytest" ,python-pytest)))
594 (home-page "https://github.com/GaretJax/sphinx-autobuild")
595 (synopsis "Rebuild Sphinx documentation when a change is detected")
597 "This package lets you watch a Sphinx directory and rebuild the
598 documentation when a change is detected. It also includes a livereload
599 enabled web server.")
600 (license license:expat)))
602 (define-public python-nbsphinx
604 (name "python-nbsphinx")
609 (uri (pypi-uri "nbsphinx" version))
612 "0j56bxdj08vn3q1804qwb1ywhga1mdg1awgm7i64wfpfwi8df2zm"))))
613 (build-system python-build-system)
615 `(("python-docutils" ,python-docutils)
616 ("python-jinja2" ,python-jinja2)
617 ("python-nbconvert" ,python-nbconvert)
618 ("python-nbformat" ,python-nbformat)
619 ("python-sphinx" ,python-sphinx)
620 ("python-traitlets" ,python-traitlets)))
621 (home-page "https://nbsphinx.readthedocs.io/")
622 (synopsis "Jupyter Notebook Tools for Sphinx")
623 (description "@code{python-nbsphinx} is a Sphinx extension that
624 provides a source parser for @code{*.ipynb} files. Custom Sphinx
625 directives are used to show Jupyter Notebook code cells (and of course
626 their results) in both HTML and LaTeX output. Un-evaluated notebooks
627 - i.e. notebooks without stored output cells - will be automatically
628 executed during the Sphinx build process.")
629 (license license:expat)))