[PATCH 0/5] Sphinx reproducibility update

[PATCH 0/5] Sphinx reproducibility update

[Leo Famulari]

Since version 1.4.0, Sphinx has respected the SOURCE_DATE_EPOCH
environment variable for the timestamps it puts in generated
documentation [0].

This patch series updates Sphinx to the latest version, 1.4.4, and
provides all the new dependencies. The final commit in the series
requires the new Sphinx.

Why propagate pytz and snowballstemmer? Otherwise, many packages that
use Sphinx started failing due to pytz or snowballstemmer not being
avaiable. Rather than provide pytz and snowballstemmer to all those
packages, I propagated them from Sphinx itself. I can add pytz and
snowballstemmer to the Sphinx users if desired.

With this change, many Python 2 packages will become reproducible, at
least on a single machine; the only thing holding them back was the
manpage timestamps.

These changes will require 142 rebuilds, mostly of Python packages, but
also of libreoffice (libreoffice seems to depend on *everything*) and a
few others. If the patches are good, should they go to master or to
another branch?

[0]
https://github.com/sphinx-doc/sphinx/commit/dea6a4112729c72246b7bdea139c5100c0fcdb7d

Leo Famulari (5):
  gnu: Add python-imagesize.
  gnu: Add python-alabaster.
  gnu: Add python-snowballstemmer.
  gnu: python-sphinx: Update to 1.4.4.
  gnu: python-sphinx-rtd-theme: Update to 0.1.9.

 gnu/packages/python.scm | 106 ++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 93 insertions(+), 13 deletions(-)

-- 
2.9.0

[PATCH 1/5] gnu: Add python-imagesize.

[Leo Famulari]

* gnu/packages/python.scm (python-imagesize, python2-imagesize): New variables.
---
 gnu/packages/python.scm | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/gnu/packages/python.scm b/gnu/packages/python.scm
index 597ca6a..469f1fa 100644
--- a/gnu/packages/python.scm
+++ b/gnu/packages/python.scm
@@ -9693,3 +9693,29 @@ characters, mouse support, and auto suggestions.")
       (native-inputs
        `(("python2-setuptools" ,python2-setuptools)
          ,@(package-native-inputs base))))))
+
+(define-public python-imagesize
+  (package
+    (name "python-imagesize")
+    (version "0.7.1")
+    (source (origin
+              (method url-fetch)
+              (uri (pypi-uri "imagesize" version))
+              (sha256
+               (base32
+                "0qk07k0z4241lkzzjji7z4da04pcvg7bfc4xz1934zlqhwmwdcha"))))
+    (build-system python-build-system)
+    (synopsis "Calculate the size of an image")
+    (description "This Python module returns the size of an image. It supports
+the PNG, JPEG, JPEG 2000, and GIF formats.")
+    (home-page "https://github.com/shibukawa/imagesize_py")
+    (license license:expat)
+    (properties `((python2-variant . ,(delay python2-imagesize))))))
+
+(define-public python2-imagesize
+  (let ((base (package-with-python2 (strip-python2-variant python-imagesize))))
+    (package
+      (inherit base)
+      (native-inputs
+       `(("python2-setuptools" ,python2-setuptools)
+         ,@(package-native-inputs base))))))
-- 
2.9.0

[PATCH 2/5] gnu: Add python-alabaster.

[Leo Famulari]

* gnu/packages/python.scm (python-alabaster, python2-alabaster): New variables.
---
 gnu/packages/python.scm | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/gnu/packages/python.scm b/gnu/packages/python.scm
index 469f1fa..4eed92f 100644
--- a/gnu/packages/python.scm
+++ b/gnu/packages/python.scm
@@ -9719,3 +9719,30 @@ the PNG, JPEG, JPEG 2000, and GIF formats.")
       (native-inputs
        `(("python2-setuptools" ,python2-setuptools)
          ,@(package-native-inputs base))))))
+
+(define-public python-alabaster
+  (package
+    (name "python-alabaster")
+    (version "0.7.8")
+    (source (origin
+              (method url-fetch)
+              (uri (pypi-uri "alabaster" version))
+              (sha256
+               (base32
+                "1zqz9hsvnmpjklmir6g7rxlv2fslrgsnwb91r9sgz4n1zja1pjx1"))))
+    (build-system python-build-system)
+    (synopsis "Default theme for the Sphinx documentation system")
+    (description "Alabaster is a responsive and configurable theme for the
+Sphinx documentation system. It is compatible with Python 2 and 3, and it is the
+default Sphinx theme.")
+    (home-page "https://github.com/bitprophet/alabaster")
+    (license bsd-3)
+    (properties `((python2-variant . ,(delay python2-alabaster))))))
+
+(define-public python2-alabaster
+  (let ((base (package-with-python2 (strip-python2-variant python-alabaster))))
+    (package
+      (inherit base)
+      (native-inputs
+       `(("python2-setuptools" ,python2-setuptools)
+         ,@(package-native-inputs base))))))
-- 
2.9.0

[PATCH 3/5] gnu: Add python-snowballstemmer.

[Leo Famulari]

* gnu/packages/python.scm (python-snowballstemmer, python2-snowballstemmer): New
variables.
---
 gnu/packages/python.scm | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/gnu/packages/python.scm b/gnu/packages/python.scm
index 4eed92f..73312e8 100644
--- a/gnu/packages/python.scm
+++ b/gnu/packages/python.scm
@@ -9746,3 +9746,25 @@ default Sphinx theme.")
       (native-inputs
        `(("python2-setuptools" ,python2-setuptools)
          ,@(package-native-inputs base))))))
+
+(define-public python-snowballstemmer
+  (package
+    (name "python-snowballstemmer")
+    (version "1.2.1")
+    (source (origin
+              (method url-fetch)
+              (uri (pypi-uri "snowballstemmer" version))
+              (sha256
+               (base32
+                "0a0idq4y5frv7qsg2x62jd7rd272749xk4x99misf5rcifk2d7wi"))))
+    (build-system python-build-system)
+    (arguments
+     `(#:tests? #f)) ; no test suite
+    (synopsis "Snowball stemming library collection for Python")
+    (description "This package provides 16 stemmer algorithms generated from
+Snowball algorithms")
+    (home-page "https://github.com/shibukawa/snowball_py")
+    (license bsd-2)))
+
+(define-public python2-snowballstemmer
+  (package-with-python2 python-snowballstemmer))
-- 
2.9.0

[PATCH 4/5] gnu: python-sphinx: Update to 1.4.4.

[Leo Famulari]

* gnu/packages/python.scm (python-sphinx, python2-sphinx): Update to 1.4.4.
[source]: Use pypi-uri.
[inputs]: Add python-alabaster, python-babel, python-imagesize, python-six.
[propagated-inputs]: New field.
---
 gnu/packages/python.scm | 23 +++++++++++++++--------
 1 file changed, 15 insertions(+), 8 deletions(-)

diff --git a/gnu/packages/python.scm b/gnu/packages/python.scm
index 73312e8..fd4cc3d 100644
--- a/gnu/packages/python.scm
+++ b/gnu/packages/python.scm
@@ -2658,22 +2658,29 @@ reStructuredText.")
 (define-public python-sphinx
   (package
     (name "python-sphinx")
-    (version "1.2.3")
+    (version "1.4.4")
     (source
      (origin
        (method url-fetch)
-       (uri (string-append
-             "https://pypi.python.org/packages/source/S/Sphinx/Sphinx-"
-             version ".tar.gz"))
+       (uri (pypi-uri "Sphinx" version))
        (sha256
         (base32
-         "011xizm3jnmf4cvs5i6kgf6c5nn046h79i8j0vd0f27yw9j3p4wl"))))
+         "185zklh44fhrwp1dg6251g3w6zmssh5jzvbz8pvmkg9l6wvxdzry"))))
     (build-system python-build-system)
     (inputs
-     `(("python-setuptools" ,python-setuptools)
-       ("python-jinja2" ,python-jinja2)
+     `(
+       ("python-alabaster" ,python-alabaster)
+       ("python-babel" ,python-babel)
        ("python-docutils" ,python-docutils)
-       ("python-pygments" ,python-pygments)))
+       ("python-imagesize" ,python-imagesize)
+       ("python-jinja2" ,python-jinja2)
+       ("python-pygments" ,python-pygments)
+       ("python-pytz" ,python-pytz)
+       ("python-setuptools" ,python-setuptools)
+       ("python-six" ,python-six)))
+    (propagated-inputs
+     `(("python-pytz" ,python-pytz)
+       ("python-snowballstemmer" ,python-snowballstemmer)))
     (home-page "http://sphinx-doc.org/")
     (synopsis "Python documentation generator")
     (description "Sphinx is a tool that makes it easy to create documentation
-- 
2.9.0

[PATCH 5/5] gnu: python-sphinx-rtd-theme: Update to 0.1.9.

[Leo Famulari]

* gnu/packages/python.scm (python-sphinx-rtd-theme, python2-sphinx-rtd-theme):
Update to 0.1.9.
---
 gnu/packages/python.scm | 8 +++-----
 1 file changed, 3 insertions(+), 5 deletions(-)

diff --git a/gnu/packages/python.scm b/gnu/packages/python.scm
index fd4cc3d..10ab3a6 100644
--- a/gnu/packages/python.scm
+++ b/gnu/packages/python.scm
@@ -2694,16 +2694,14 @@ sources.")
 (define-public python-sphinx-rtd-theme
   (package
     (name "python-sphinx-rtd-theme")
-    (version "0.1.6")
+    (version "0.1.9")
     (source
      (origin
        (method url-fetch)
-       (uri (string-append "https://pypi.python.org/packages/source/s/"
-                           "sphinx_rtd_theme/sphinx_rtd_theme-"
-                           version ".tar.gz"))
+       (uri (pypi-uri "sphinx_rtd_theme" version))
        (sha256
         (base32
-         "19nw3rn7awplcdrz63kg1njqwkbymfg9lwn7l2grhdyhyr2gaa8g"))))
+         "18d0r63w7jpdrk4q5qy26n08vdlmnj9sar93akwjphyambw4cf17"))))
     (build-system python-build-system)
     (arguments
      `(;; With standard flags, the install phase attempts to create a zip'd
-- 
2.9.0

Re: [PATCH 3/5] gnu: Add python-snowballstemmer.

[宋文武]

Leo Famulari <leo@famulari.name> writes:

> * gnu/packages/python.scm (python-snowballstemmer, python2-snowballstemmer): New
> variables.
> ---
>  gnu/packages/python.scm | 22 ++++++++++++++++++++++
>  1 file changed, 22 insertions(+)
>
> diff --git a/gnu/packages/python.scm b/gnu/packages/python.scm
> index 4eed92f..73312e8 100644
> --- a/gnu/packages/python.scm
> +++ b/gnu/packages/python.scm
> @@ -9746,3 +9746,25 @@ default Sphinx theme.")
>        (native-inputs
>         `(("python2-setuptools" ,python2-setuptools)
>           ,@(package-native-inputs base))))))
> +
> +(define-public python-snowballstemmer
> +  (package
> +    (name "python-snowballstemmer")
> +    (version "1.2.1")
> +    (source (origin
> +              (method url-fetch)
> +              (uri (pypi-uri "snowballstemmer" version))
> +              (sha256
> +               (base32
> +                "0a0idq4y5frv7qsg2x62jd7rd272749xk4x99misf5rcifk2d7wi"))))
> +    (build-system python-build-system)
> +    (arguments
> +     `(#:tests? #f)) ; no test suite
> +    (synopsis "Snowball stemming library collection for Python")
> +    (description "This package provides 16 stemmer algorithms generated from
> +Snowball algorithms")
Missing period.

Re: [PATCH 0/5] Sphinx reproducibility update

[宋文武]

Leo Famulari <leo@famulari.name> writes:
> [...]
>
> With this change, many Python 2 packages will become reproducible, at
> least on a single machine; the only thing holding them back was the
> manpage timestamps.
Cool!

>
> These changes will require 142 rebuilds, mostly of Python packages, but
> also of libreoffice (libreoffice seems to depend on *everything*) and a
> few others. If the patches are good, should they go to master or to
> another branch?
>
I prefer master, and I guess people who use libreoffice don't update it
frequently (we have a old version, but no one complain so far).

Re: [PATCH 0/5] Sphinx reproducibility update

[Ludovic Courtès]

Hello,

Leo Famulari <leo@famulari.name> skribis:

> Since version 1.4.0, Sphinx has respected the SOURCE_DATE_EPOCH
> environment variable for the timestamps it puts in generated
> documentation [0].

Awesome!

> This patch series updates Sphinx to the latest version, 1.4.4, and
> provides all the new dependencies. The final commit in the series
> requires the new Sphinx.
>
> Why propagate pytz and snowballstemmer? Otherwise, many packages that
> use Sphinx started failing due to pytz or snowballstemmer not being
> avaiable. Rather than provide pytz and snowballstemmer to all those
> packages, I propagated them from Sphinx itself. I can add pytz and
> snowballstemmer to the Sphinx users if desired.

Makes sense.

> With this change, many Python 2 packages will become reproducible, at
> least on a single machine; the only thing holding them back was the
> manpage timestamps.
>
> These changes will require 142 rebuilds, mostly of Python packages, but
> also of libreoffice (libreoffice seems to depend on *everything*) and a
> few others. If the patches are good, should they go to master or to
> another branch?

You could push them to ‘core-updates’ as a way to save a little bit of
build time.

Thank you!

Ludo’.

Re: [PATCH 0/5] Sphinx reproducibility update

[Ludovic Courtès]

iyzsong@member.fsf.org (宋文武) skribis:

> Leo Famulari <leo@famulari.name> writes:
>> [...]
>>
>> With this change, many Python 2 packages will become reproducible, at
>> least on a single machine; the only thing holding them back was the
>> manpage timestamps.
> Cool!
>
>>
>> These changes will require 142 rebuilds, mostly of Python packages, but
>> also of libreoffice (libreoffice seems to depend on *everything*) and a
>> few others. If the patches are good, should they go to master or to
>> another branch?
>>
> I prefer master, and I guess people who use libreoffice don't update it
> frequently (we have a old version, but no one complain so far).

(Oops, I replied before seeing your message.)  I have a slight
preference for ‘core-updates’, which I hope can be merged within a few
days.  Sounds good?

Ludo’.

Re: [PATCH 1/5] gnu: Add python-imagesize.

[Ludovic Courtès]

Leo Famulari <leo@famulari.name> skribis:

> * gnu/packages/python.scm (python-imagesize, python2-imagesize): New variables.

[...]

> +    (description "This Python module returns the size of an image. It supports

Two spaces after period.  :-)

Otherwise LGTM, thanks.

Ludo’.

Re: [PATCH 2/5] gnu: Add python-alabaster.

[Ludovic Courtès]

Leo Famulari <leo@famulari.name> skribis:

> * gnu/packages/python.scm (python-alabaster, python2-alabaster): New variables.

[...]

> +Sphinx documentation system. It is compatible with Python 2 and 3, and it is the
                              ^^
Two spaces after period, but otherwise LGTM.

Ludo’.

Re: [PATCH 4/5] gnu: python-sphinx: Update to 1.4.4.

[Ludovic Courtès]

Leo Famulari <leo@famulari.name> skribis:

> * gnu/packages/python.scm (python-sphinx, python2-sphinx): Update to 1.4.4.
> [source]: Use pypi-uri.
> [inputs]: Add python-alabaster, python-babel, python-imagesize, python-six.
> [propagated-inputs]: New field.

[...]

> +    (propagated-inputs
> +     `(("python-pytz" ,python-pytz)
> +       ("python-snowballstemmer" ,python-snowballstemmer)))

Please put the explanation for the propagation as a comment here (I
assume installed .py files “import” modules from these two packages.)

OK with this change!

Ludo’.

Re: [PATCH 5/5] gnu: python-sphinx-rtd-theme: Update to 0.1.9.

[Ludovic Courtès]

Leo Famulari <leo@famulari.name> skribis:

> * gnu/packages/python.scm (python-sphinx-rtd-theme, python2-sphinx-rtd-theme):
> Update to 0.1.9.

OK!

Re: [PATCH 0/5] Sphinx reproducibility update

[Leo Famulari]

On Sun, Jul 03, 2016 at 11:54:02PM +0200, Ludovic Courtès wrote:
> iyzsong@member.fsf.org (宋文武) skribis:
> 
> > Leo Famulari <leo@famulari.name> writes:
> >> [...]
> >>
> >> With this change, many Python 2 packages will become reproducible, at
> >> least on a single machine; the only thing holding them back was the
> >> manpage timestamps.
> > Cool!
> >
> >>
> >> These changes will require 142 rebuilds, mostly of Python packages, but
> >> also of libreoffice (libreoffice seems to depend on *everything*) and a
> >> few others. If the patches are good, should they go to master or to
> >> another branch?
> >>
> > I prefer master, and I guess people who use libreoffice don't update it
> > frequently (we have a old version, but no one complain so far).
> 
> (Oops, I replied before seeing your message.)  I have a slight
> preference for ‘core-updates’, which I hope can be merged within a few
> days.  Sounds good?

I incorporated the reviewers' comments and applied to core-updates,
bringing it to 98529948.

Thank you!