From: Efraim Flashner <efraim@flashner.co.il>
To: 50490@debbugs.gnu.org
Cc: Efraim Flashner <efraim@flashner.co.il>
Subject: [bug#50490] [PATCH 4/4] gnu: Add julia-documenter.
Date: Tue, 14 Sep 2021 21:19:27 +0300 [thread overview]
Message-ID: <eeb8e3dfcaf3040232e9d53f07ace058f72510bf.1631624546.git.efraim@flashner.co.il> (raw)
In-Reply-To: <cover.1631624546.git.efraim@flashner.co.il>
* 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")
--
2.33.0
next prev parent reply other threads:[~2021-09-14 18:38 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-09-14 13:08 [bug#50582] [PATCH 0/4] Julia-documenter Efraim Flashner
2021-09-14 13:11 ` [bug#50582] [PATCH 1/4] gnu: Add julia-libsass-jll Efraim Flashner
2021-09-27 17:01 ` [bug#50490] [PATCH 0/5] Some julia packages zimoun
2021-09-14 13:12 ` [bug#50582] [PATCH 2/4] gnu: Add julia-sass Efraim Flashner
2021-09-27 17:03 ` [bug#50490] [PATCH 0/5] Some julia packages zimoun
2021-09-14 18:19 ` [bug#50490] [PATCH 3/4] gnu: Add julia-ansicoloredprinters Efraim Flashner
2021-09-27 17:04 ` [bug#50490] [PATCH 0/5] Some julia packages zimoun
2021-09-14 18:19 ` Efraim Flashner [this message]
2021-09-27 17:11 ` zimoun
2021-09-30 11:18 ` Efraim Flashner
[not found] ` <handler.50582.B.163162505210361.ack@debbugs.gnu.org>
2021-09-14 18:31 ` [bug#50582] Acknowledgement ([PATCH 0/4] Julia-documenter) Efraim Flashner
2021-09-27 17:15 ` [bug#50582] [PATCH 0/4] Julia-documenter zimoun
2021-09-29 7:21 ` Efraim Flashner
2021-09-30 11:26 ` bug#50582: " Efraim Flashner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://guix.gnu.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=eeb8e3dfcaf3040232e9d53f07ace058f72510bf.1631624546.git.efraim@flashner.co.il \
--to=efraim@flashner.co.il \
--cc=50490@debbugs.gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/guix.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).