From 423b61f07f03f97b647cf9353366b3d53e624ad8 Mon Sep 17 00:00:00 2001 From: Uwe Hernandez Acosta Date: Thu, 28 Sep 2023 13:31:15 +0200 Subject: [PATCH 1/4] fixed issue #21 --- docs/Project.toml | 1 + docs/make.jl | 4 ++-- docs/src/library/api.md | 3 ++- src/QEDbase.jl | 6 ------ src/lorentz_interface.jl | 2 +- src/particle_spinors.jl | 1 + 6 files changed, 7 insertions(+), 10 deletions(-) diff --git a/docs/Project.toml b/docs/Project.toml index 6c8f953..b927490 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -3,3 +3,4 @@ DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae" Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244" DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8" +QEDbase = "10e22c08-3ccb-4172-bfcf-7d7aa3d04d93" diff --git a/docs/make.jl b/docs/make.jl index 16a5185..d36f574 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -6,7 +6,7 @@ using QEDbase using DocumenterCitations -bib = CitationBibliography(joinpath(@__DIR__, "Bibliography.bib"); sorting=:y) +bib = CitationBibliography(joinpath(@__DIR__, "Bibliography.bib")) pages = [ "Home" => "index.md", @@ -22,7 +22,6 @@ pages = [ ] makedocs( - bib; modules=[QEDbase], checkdocs=:exports, authors="Uwe Hernandez Acosta", @@ -34,4 +33,5 @@ makedocs( assets=String[], ), pages=pages, + plugins = [bib] ) diff --git a/docs/src/library/api.md b/docs/src/library/api.md index e1d8e6e..4b996da 100644 --- a/docs/src/library/api.md +++ b/docs/src/library/api.md @@ -3,7 +3,8 @@ ```@autodocs Modules = [QEDbase] -Pages = ["QEDbase.jl"] +Pages = ["QEDbase.jl"] +Order = [:module] ``` # Lorentz Vector Interface diff --git a/src/QEDbase.jl b/src/QEDbase.jl index 7de3374..a086729 100644 --- a/src/QEDbase.jl +++ b/src/QEDbase.jl @@ -1,9 +1,3 @@ -""" -Main module of QEDbase.jl - a little library for manipulating Lorentz vectors and Dirac tensors. - -# Exports -$(EXPORTS) -""" module QEDbase using SimpleTraits diff --git a/src/lorentz_interface.jl b/src/lorentz_interface.jl index f04f74a..c1ff32e 100644 --- a/src/lorentz_interface.jl +++ b/src/lorentz_interface.jl @@ -960,7 +960,7 @@ Sets the rapidity of a `LorentzVectorLike` to a given `value`. !!! note - The `value` set with `setRapidity!` is then returned by [`setRapidity`](@ref). Since the rapidity is computed on the call of `setRapidity`, the setter `setRapidity!` changes several components of the given `LorentzVectorLike`. + The `value` set with `setRapidity!` is then returned by [`getRapidity`](@ref). Since the rapidity is computed on the call of `setRapidity`, the setter `setRapidity!` changes several components of the given `LorentzVectorLike`. """ @traitfn function setRapidity!(lv::T, rap::VT) where {T,VT;IsMutableLorentzVectorLike{T}} diff --git a/src/particle_spinors.jl b/src/particle_spinors.jl index 56fb1c3..a3b25d1 100644 --- a/src/particle_spinors.jl +++ b/src/particle_spinors.jl @@ -3,6 +3,7 @@ import Base.getindex const SPINOR_VALIDITY_CHECK = Ref(true) + macro valid_spinor_input(ex) return quote SPINOR_VALIDITY_CHECK.x = false From 0945480641c7f03241ba61789d50fbd2018c1260 Mon Sep 17 00:00:00 2001 From: Uwe Hernandez Acosta Date: Thu, 28 Sep 2023 14:38:08 +0200 Subject: [PATCH 2/4] removed make_local.jl --- docs/make_local.jl | 5 ----- 1 file changed, 5 deletions(-) delete mode 100644 docs/make_local.jl diff --git a/docs/make_local.jl b/docs/make_local.jl deleted file mode 100644 index 166d3d8..0000000 --- a/docs/make_local.jl +++ /dev/null @@ -1,5 +0,0 @@ -using Pkg -Pkg.instantiate() -Pkg.develop(; path=".") - -include("make.jl") From 467cfee0f154b891c26cb107662a21446c12d050 Mon Sep 17 00:00:00 2001 From: Uwe Hernandez Acosta Date: Thu, 28 Sep 2023 14:39:30 +0200 Subject: [PATCH 3/4] formatting --- docs/make.jl | 4 ++-- src/particle_spinors.jl | 1 - 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/make.jl b/docs/make.jl index d36f574..ae67b1e 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -21,7 +21,7 @@ pages = [ "refs.md", ] -makedocs( +makedocs(; modules=[QEDbase], checkdocs=:exports, authors="Uwe Hernandez Acosta", @@ -33,5 +33,5 @@ makedocs( assets=String[], ), pages=pages, - plugins = [bib] + plugins=[bib], ) diff --git a/src/particle_spinors.jl b/src/particle_spinors.jl index a3b25d1..56fb1c3 100644 --- a/src/particle_spinors.jl +++ b/src/particle_spinors.jl @@ -3,7 +3,6 @@ import Base.getindex const SPINOR_VALIDITY_CHECK = Ref(true) - macro valid_spinor_input(ex) return quote SPINOR_VALIDITY_CHECK.x = false From e1e43e2a695bac1f771dc13e4b65053395a7eb2d Mon Sep 17 00:00:00 2001 From: Uwe Hernandez Acosta Date: Thu, 28 Sep 2023 15:15:03 +0200 Subject: [PATCH 4/4] fixed wrong path for make.jl --- docs/make.jl | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/make.jl b/docs/make.jl index ae67b1e..0d622c0 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,4 +1,11 @@ +using Pkg + +# targeting the correct source code +# this asumes the make.jl script is located in QEDbase.jl/docs +project_path = Base.Filesystem.joinpath(Base.Filesystem.dirname(Base.source_path()), "..") +Pkg.develop(path=project_path) + using Documenter using QEDbase @@ -6,6 +13,7 @@ using QEDbase using DocumenterCitations + bib = CitationBibliography(joinpath(@__DIR__, "Bibliography.bib")) pages = [