From patchwork Tue Sep 14 18:19:27 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Efraim Flashner X-Patchwork-Id: 32833 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id 86F9727BBE3; Tue, 14 Sep 2021 19:38:32 +0100 (BST) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-2.9 required=5.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_DNSWL_BLOCKED,RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.2 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id B516B27BBE1 for ; Tue, 14 Sep 2021 19:38:31 +0100 (BST) Received: from localhost ([::1]:44474 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mQDKA-00010O-Qv for patchwork@mira.cbaines.net; Tue, 14 Sep 2021 14:38:30 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:59168) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mQDJi-000105-Lp for guix-patches@gnu.org; Tue, 14 Sep 2021 14:38:02 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:38619) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mQDJi-0003RT-ED for guix-patches@gnu.org; Tue, 14 Sep 2021 14:38:02 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1mQDJi-0007Wk-C1 for guix-patches@gnu.org; Tue, 14 Sep 2021 14:38:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#50490] [PATCH 4/4] gnu: Add julia-documenter. Resent-From: Efraim Flashner Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Tue, 14 Sep 2021 18:38:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 50490 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 50490@debbugs.gnu.org Cc: Efraim Flashner Received: via spool by 50490-submit@debbugs.gnu.org id=B50490.163164462328849 (code B ref 50490); Tue, 14 Sep 2021 18:38:02 +0000 Received: (at 50490) by debbugs.gnu.org; 14 Sep 2021 18:37:03 +0000 Received: from localhost ([127.0.0.1]:50162 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mQDIk-0007V9-Et for submit@debbugs.gnu.org; Tue, 14 Sep 2021 14:37:02 -0400 Received: from flashner.co.il ([178.62.234.194]:37904) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mQDIi-0007Ul-EE for 50490@debbugs.gnu.org; Tue, 14 Sep 2021 14:37:00 -0400 Received: from localhost (unknown [141.226.169.107]) by flashner.co.il (Postfix) with ESMTPSA id 899174035D; Tue, 14 Sep 2021 18:36:54 +0000 (UTC) From: Efraim Flashner Date: Tue, 14 Sep 2021 21:19:27 +0300 Message-Id: X-Mailer: git-send-email 2.33.0 In-Reply-To: References: MIME-Version: 1.0 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org Sender: "Guix-patches" X-getmail-retrieved-from-mailbox: Patches * 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(-) 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 + (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") + (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")