[bug#50490,4/4] gnu: Add julia-documenter.

* gnu/packages/julia-xyz.scm (julia-documenter,
julia-documentermarkdown, julia-documentertools): New variables.
(julia-documenter-0.22): New hidden variable.
---
 gnu/packages/julia-xyz.scm | 146 ++++++++++++++++++++++++++++++++++++-
 1 file changed, 145 insertions(+), 1 deletion(-)

Hi Efraim,

On mar., 14 sept. 2021 at 21:19, Efraim Flashner <efraim@flashner.co.il> wrote:

I would add here an explanation, along these lines: «These four
variables are added by the same commit to avoid a cyclic dependency.»

> * gnu/packages/julia-xyz.scm (julia-documenter,
> julia-documentermarkdown, julia-documentertools): New variables.
> (julia-documenter-0.22): New hidden variable.
> ---
>  gnu/packages/julia-xyz.scm | 146 ++++++++++++++++++++++++++++++++++++-
>  1 file changed, 145 insertions(+), 1 deletion(-)

The patch does not apply…

> diff --git a/gnu/packages/julia-xyz.scm b/gnu/packages/julia-xyz.scm
> index 309687019d..e7e7680cca 100644
> --- a/gnu/packages/julia-xyz.scm
> +++ b/gnu/packages/julia-xyz.scm
> @@ -26,7 +26,9 @@ (define-module (gnu packages julia-xyz)
>    #:use-module (guix git-download)
>    #:use-module (guix build-system julia)
>    #:use-module (gnu packages gcc)
> -  #:use-module (gnu packages julia-jll))
> +  #:use-module (gnu packages julia-jll)
> +  #:use-module (gnu packages python)
> +  #:use-module (gnu packages version-control))
>
>  (define-public julia-abstractffts
>    (package
> @@ -990,6 +992,148 @@ (define-public julia-docstringextensions
>  valuable enough at this time.")
>      (license license:expat)))
>
> +;; By removing all the javascript and css downloads any HTML documentation
> +;; produced by this package will not be very useful.
> +(define-public julia-documenter
> +  (package
> +    (name "julia-documenter")
> +    (version "0.27.6")
> +    (source
> +      (origin
> +        (method git-fetch)
> +        (uri (git-reference
> +               (url "https://github.com/JuliaDocs/Documenter.jl")
> +               (commit (string-append "v" version))))
> +        (file-name (git-file-name name version))
> +        (sha256
> +         (base32 "1y6rql7cxc7hfhc8rfq1mdmffp70sqzyh4vnnq93fziwrc8c8sbj"))))
> +    (build-system julia-build-system)
> +    (arguments
> +     `(#:phases
> +       (modify-phases %standard-phases
> +         (add-after 'unpack 'patch-source
> +           (lambda* (#:key inputs #:allow-other-keys)
> +             (substitute* "src/Deps.jl"
> +               (("pip install")
> +                (string-append (assoc-ref inputs "python")
> +                               "/bin/pip install")))
> +             #t))
> +         (add-after 'unpack 'remove-javascript-downloads
> +           (lambda _
> +             (substitute* "src/Writers/HTMLWriter.jl"
> +               (("cdnjs.cloudflare.com") "example.com"))
> +             ;; Removing the javascript downloads causes these tests fail.
> +             (substitute* "test/examples/tests.jl"
> +               ((".*Main\\.examples_html_doc.*") "")
> +               ((".*Main\\.examples_html_mathjax3_doc.*") ""))
> +             #t)))))
> +    (propagated-inputs
> +     `(("julia-ansicoloredprinters" ,julia-ansicoloredprinters)
> +       ("julia-docstringextensions" ,julia-docstringextensions)
> +       ("julia-iocapture" ,julia-iocapture)
> +       ("julia-json" ,julia-json)))
> +    (inputs
> +     `(("python" ,python-wrapper)))
> +    (native-inputs
> +     `(("git" ,git-minimal)
> +       ("julia-documentermarkdown" ,julia-documentermarkdown)
> +       ("julia-documentertools" ,julia-documentertools)))
> +    (home-page "https://juliadocs.github.io/Documenter.jl")
> +    (synopsis "Documentation generator for Julia")
> +    (description "This package provides a documentation generator for Julia.")
> +    (license license:expat)))
> +
> +(define-public julia-documenter-0.22

Do we need to make it public?  Is it not enough to keep it hidden?

> +  (package
> +    (inherit julia-documenter)
> +    (name "julia-documenter")
> +    (version "0.22.6")
> +    (source
> +      (origin
> +        (method git-fetch)
> +        (uri (git-reference
> +               (url "https://github.com/JuliaDocs/Documenter.jl")
> +               (commit (string-append "v" version))))
> +        (file-name (git-file-name name version))
> +        (sha256
> +         (base32
> +          "1z8b7267y7yn5nx8sjwkmc0ph97vmv42q52jg7s89ghqb9xx3wv5"))))
> +    (arguments
> +     `(#:tests? #f      ; Some tests require network.
> +       #:phases
> +       (modify-phases %standard-phases
> +         (add-after 'unpack 'remove-javascript-downloads
> +           (lambda _
> +             ;; This isn't problematic because we only use
> +             ;; this package for bootstrapping.
> +             (substitute* '("assets/html/documenter.js"
> +                            "assets/html/search.js"
> +                            "src/Writers/HTMLWriter.jl")
> +               (("cdnjs.cloudflare.com") "example.com"))
> +             #t)))))
> +    (propagated-inputs
> +     `(("julia-docstringextensions" ,julia-docstringextensions)
> +       ("julia-json" ,julia-json)))
> +    (inputs `())
> +    (native-inputs `())
> +    (properties '((hidden? . #t)))))
> +
> +(define-public julia-documentermarkdown
> +  (package
> +    (name "julia-documentermarkdown")
> +    (version "0.2.2")
> +    (source
> +      (origin
> +        (method git-fetch)
> +        (uri (git-reference
> +               (url "https://github.com/JuliaDocs/DocumenterMarkdown.jl")
> +               (commit (string-append "v" version))))
> +        (file-name (git-file-name name version))
> +        (sha256
> +         (base32 "0sx89hi5p2f8zi2rp5qrv06m270d90pxj5d2y5cxls1spax7wqx8"))))
> +    (build-system julia-build-system)
> +    (inputs
> +     ;; We don't want to propagate the bootstrap version.
> +     ;; Cycle with Documenter.jl in later versions.
> +     `(("julia-documenter" ,julia-documenter-0.22)))
> +    (home-page "https://github.com/JuliaDocs/DocumenterMarkdown.jl")
> +    (synopsis "Documenter's Markdown")
> +    (description "This package enables the Markdown / MkDocs backend of
> +@code{Documenter.jl}.")
> +    (license license:expat)))
> +
> +(define-public julia-documentertools
> +  (package
> +    (name "julia-documentertools")
> +    (version "0.1.13")
> +    (source
> +      (origin
> +        (method git-fetch)
> +        (uri (git-reference
> +               (url "https://github.com/JuliaDocs/DocumenterTools.jl")
> +               (commit (string-append "v" version))))
> +        (file-name (git-file-name name version))
> +        (sha256
> +         (base32 "05p57p8xlkn42m1lv9gq4hl96vp7hpj19d51p828ai1rbpcpi3a6"))))
> +    (build-system julia-build-system)
> +    (arguments
> +     `(#:tests? #f))    ; Tests require network.
> +    (inputs
> +     ;; We don't want to propagate the bootstrap version.
> +     ;; Cycle with Documenter.jl in later versions.
> +     `(("julia-documenter" ,julia-documenter-0.22)))
> +    (propagated-inputs
> +     `(("julia-docstringextensions" ,julia-docstringextensions)
> +       ("julia-gumbo" ,julia-gumbo)
> +       ("julia-sass" ,julia-sass)))
> +    (native-inputs
> +     `(("julia-example" ,julia-example)))
> +    (home-page "https://github.com/JuliaDocs/DocumenterTools.jl")
> +    (synopsis "Extra tools for setting up Documenter")

I would write «setting up Documenter.jl»

> +    (description "This package contains utilities for setting up documentation
> +generation with @code{Documenter.jl}.")
> +    (license license:expat)))
> +
>  (define-public julia-diffresults
>    (package
>      (name "julia-diffresults")

…so I have not tried it.  It LGTM though.

Cheers,
simon

On Mon, Sep 27, 2021 at 07:11:18PM +0200, zimoun wrote:
> Hi Efraim,
> 
> On mar., 14 sept. 2021 at 21:19, Efraim Flashner <efraim@flashner.co.il> wrote:
> 
> I would add here an explanation, along these lines: «These four
> variables are added by the same commit to avoid a cyclic dependency.»
> 
> > * gnu/packages/julia-xyz.scm (julia-documenter,
> > julia-documentermarkdown, julia-documentertools): New variables.
> > (julia-documenter-0.22): New hidden variable.
> > ---
> >  gnu/packages/julia-xyz.scm | 146 ++++++++++++++++++++++++++++++++++++-
> >  1 file changed, 145 insertions(+), 1 deletion(-)
> 
> The patch does not apply…
Probably due to the module imports. python-xyz was added in a different
patch.
> 
> > diff --git a/gnu/packages/julia-xyz.scm b/gnu/packages/julia-xyz.scm
> > index 309687019d..e7e7680cca 100644
> > --- a/gnu/packages/julia-xyz.scm
> > +++ b/gnu/packages/julia-xyz.scm
> > @@ -26,7 +26,9 @@ (define-module (gnu packages julia-xyz)
> >    #:use-module (guix git-download)
> >    #:use-module (guix build-system julia)
> >    #:use-module (gnu packages gcc)
> > -  #:use-module (gnu packages julia-jll))
> > +  #:use-module (gnu packages julia-jll)
> > +  #:use-module (gnu packages python)
> > +  #:use-module (gnu packages version-control))
> >
> >  (define-public julia-abstractffts
> >    (package
> > @@ -990,6 +992,148 @@ (define-public julia-docstringextensions
> >  valuable enough at this time.")
> >      (license license:expat)))
> >
> > +;; By removing all the javascript and css downloads any HTML documentation
> > +;; produced by this package will not be very useful.
> > +(define-public julia-documenter
> > +  (package
> > +    (name "julia-documenter")
> > +    (version "0.27.6")
> > +    (source
> > +      (origin
> > +        (method git-fetch)
> > +        (uri (git-reference
> > +               (url "https://github.com/JuliaDocs/Documenter.jl")
> > +               (commit (string-append "v" version))))
> > +        (file-name (git-file-name name version))
> > +        (sha256
> > +         (base32 "1y6rql7cxc7hfhc8rfq1mdmffp70sqzyh4vnnq93fziwrc8c8sbj"))))
> > +    (build-system julia-build-system)
> > +    (arguments
> > +     `(#:phases
> > +       (modify-phases %standard-phases
> > +         (add-after 'unpack 'patch-source
> > +           (lambda* (#:key inputs #:allow-other-keys)
> > +             (substitute* "src/Deps.jl"
> > +               (("pip install")
> > +                (string-append (assoc-ref inputs "python")
> > +                               "/bin/pip install")))
> > +             #t))
> > +         (add-after 'unpack 'remove-javascript-downloads
> > +           (lambda _
> > +             (substitute* "src/Writers/HTMLWriter.jl"
> > +               (("cdnjs.cloudflare.com") "example.com"))
> > +             ;; Removing the javascript downloads causes these tests fail.
> > +             (substitute* "test/examples/tests.jl"
> > +               ((".*Main\\.examples_html_doc.*") "")
> > +               ((".*Main\\.examples_html_mathjax3_doc.*") ""))
> > +             #t)))))
> > +    (propagated-inputs
> > +     `(("julia-ansicoloredprinters" ,julia-ansicoloredprinters)
> > +       ("julia-docstringextensions" ,julia-docstringextensions)
> > +       ("julia-iocapture" ,julia-iocapture)
> > +       ("julia-json" ,julia-json)))
> > +    (inputs
> > +     `(("python" ,python-wrapper)))
> > +    (native-inputs
> > +     `(("git" ,git-minimal)
> > +       ("julia-documentermarkdown" ,julia-documentermarkdown)
> > +       ("julia-documentertools" ,julia-documentertools)))
> > +    (home-page "https://juliadocs.github.io/Documenter.jl")
> > +    (synopsis "Documentation generator for Julia")
> > +    (description "This package provides a documentation generator for Julia.")
> > +    (license license:expat)))
> > +
> > +(define-public julia-documenter-0.22
> 
> Do we need to make it public?  Is it not enough to keep it hidden?
It should be enough to not make it hidden and not public. Also, I took
another look at it and adjusted the package slightly so it can use the
current julia-documenter version and not an older version for the
bootstrap.
> 
> > +  (package
> > +    (inherit julia-documenter)
> > +    (name "julia-documenter")
> > +    (version "0.22.6")
> > +    (source
> > +      (origin
> > +        (method git-fetch)
> > +        (uri (git-reference
> > +               (url "https://github.com/JuliaDocs/Documenter.jl")
> > +               (commit (string-append "v" version))))
> > +        (file-name (git-file-name name version))
> > +        (sha256
> > +         (base32
> > +          "1z8b7267y7yn5nx8sjwkmc0ph97vmv42q52jg7s89ghqb9xx3wv5"))))
> > +    (arguments
> > +     `(#:tests? #f      ; Some tests require network.
> > +       #:phases
> > +       (modify-phases %standard-phases
> > +         (add-after 'unpack 'remove-javascript-downloads
> > +           (lambda _
> > +             ;; This isn't problematic because we only use
> > +             ;; this package for bootstrapping.
> > +             (substitute* '("assets/html/documenter.js"
> > +                            "assets/html/search.js"
> > +                            "src/Writers/HTMLWriter.jl")
> > +               (("cdnjs.cloudflare.com") "example.com"))
> > +             #t)))))
> > +    (propagated-inputs
> > +     `(("julia-docstringextensions" ,julia-docstringextensions)
> > +       ("julia-json" ,julia-json)))
> > +    (inputs `())
> > +    (native-inputs `())
> > +    (properties '((hidden? . #t)))))
> > +
> > +(define-public julia-documentermarkdown
> > +  (package
> > +    (name "julia-documentermarkdown")
> > +    (version "0.2.2")
> > +    (source
> > +      (origin
> > +        (method git-fetch)
> > +        (uri (git-reference
> > +               (url "https://github.com/JuliaDocs/DocumenterMarkdown.jl")
> > +               (commit (string-append "v" version))))
> > +        (file-name (git-file-name name version))
> > +        (sha256
> > +         (base32 "0sx89hi5p2f8zi2rp5qrv06m270d90pxj5d2y5cxls1spax7wqx8"))))
> > +    (build-system julia-build-system)
> > +    (inputs
> > +     ;; We don't want to propagate the bootstrap version.
> > +     ;; Cycle with Documenter.jl in later versions.
> > +     `(("julia-documenter" ,julia-documenter-0.22)))
> > +    (home-page "https://github.com/JuliaDocs/DocumenterMarkdown.jl")
> > +    (synopsis "Documenter's Markdown")
> > +    (description "This package enables the Markdown / MkDocs backend of
> > +@code{Documenter.jl}.")
> > +    (license license:expat)))
> > +
> > +(define-public julia-documentertools
> > +  (package
> > +    (name "julia-documentertools")
> > +    (version "0.1.13")
> > +    (source
> > +      (origin
> > +        (method git-fetch)
> > +        (uri (git-reference
> > +               (url "https://github.com/JuliaDocs/DocumenterTools.jl")
> > +               (commit (string-append "v" version))))
> > +        (file-name (git-file-name name version))
> > +        (sha256
> > +         (base32 "05p57p8xlkn42m1lv9gq4hl96vp7hpj19d51p828ai1rbpcpi3a6"))))
> > +    (build-system julia-build-system)
> > +    (arguments
> > +     `(#:tests? #f))    ; Tests require network.
> > +    (inputs
> > +     ;; We don't want to propagate the bootstrap version.
> > +     ;; Cycle with Documenter.jl in later versions.
> > +     `(("julia-documenter" ,julia-documenter-0.22)))
> > +    (propagated-inputs
> > +     `(("julia-docstringextensions" ,julia-docstringextensions)
> > +       ("julia-gumbo" ,julia-gumbo)
> > +       ("julia-sass" ,julia-sass)))
> > +    (native-inputs
> > +     `(("julia-example" ,julia-example)))
> > +    (home-page "https://github.com/JuliaDocs/DocumenterTools.jl")
> > +    (synopsis "Extra tools for setting up Documenter")
> 
> I would write «setting up Documenter.jl»
> 
> > +    (description "This package contains utilities for setting up documentation
> > +generation with @code{Documenter.jl}.")
> > +    (license license:expat)))
> > +
> >  (define-public julia-diffresults
> >    (package
> >      (name "julia-diffresults")
> 
> …so I have not tried it.  It LGTM though.
> 
> Cheers,
> simon