From d3063653261a7bb56c6b4b51156415ba4fa9519b Mon Sep 17 00:00:00 2001 From: Thomas Kemmer Date: Wed, 12 Feb 2025 11:02:50 +0100 Subject: [PATCH 1/6] Docs: fix docstrings --- src/Radon.jl | 4 ++-- src/Rjasanow.jl | 2 +- src/base/quadrature.jl | 2 +- src/bem/nonlocal.jl | 8 +++++++- 4 files changed, 11 insertions(+), 5 deletions(-) diff --git a/src/Radon.jl b/src/Radon.jl index 81b6f586..e12aee81 100644 --- a/src/Radon.jl +++ b/src/Radon.jl @@ -254,7 +254,7 @@ to use the shorthand signature `regularyukawacoll` instead. * `yukawa` [Exponent](@ref int-constants) of the Yukawa operator's fundamental solution # Return type -`Void` +`T` """ function radoncoll( ξ ::AbstractVector{T}, @@ -368,7 +368,7 @@ triangle and observation point `ξ`. * `yukawa` [Exponent](@ref int-constants) of the Yukawa operator's fundamental solution # Return type -`Void` +`T` """ @inline regularyukawacoll( ::Type{SingleLayer}, diff --git a/src/Rjasanow.jl b/src/Rjasanow.jl index 8dc7c6fe..8eaa7323 100644 --- a/src/Rjasanow.jl +++ b/src/Rjasanow.jl @@ -357,7 +357,7 @@ and observation point `ξ` [[Rja90]](@ref Bibliography). The result is premultiplied by 4π. # Return type -`Void` +`T` """ function laplacecoll( ptype::Type{P}, diff --git a/src/base/quadrature.jl b/src/base/quadrature.jl index d05ffab5..e86d3542 100644 --- a/src/base/quadrature.jl +++ b/src/base/quadrature.jl @@ -121,7 +121,7 @@ Quadrature points on a specific surface triangle, including weights. # Special constructors ```julia TriangleQuad(elem::Triangle{T}) -```` +``` Computes quadrature points and weights for the given triangle. """ struct TriangleQuad{T} <: ElementQuad{T} diff --git a/src/bem/nonlocal.jl b/src/bem/nonlocal.jl index dcb0f499..47137a19 100644 --- a/src/bem/nonlocal.jl +++ b/src/bem/nonlocal.jl @@ -165,8 +165,14 @@ Implicit representation of the nonlocal BEM system matrix. # Special constructors ```julia - +function NonlocalSystemMatrix{T}( + Ξ ::Vector{Vector{T}}, + elements::Vector{Triangle{T}}, + params ::Option{T} +) where T ``` +Creates the nonlocal system matrix directly from the given observation points `Ξ` and +surface `elements`. """ struct NonlocalSystemMatrix{T} <: AbstractArray{T, 2} """Single-layer Laplace potentials""" From 9069ea7c63bb66e8e578fb1f92aeedd5784eebca Mon Sep 17 00:00:00 2001 From: Thomas Kemmer Date: Wed, 12 Feb 2025 11:03:22 +0100 Subject: [PATCH 2/6] Docs: add missing type refs to docstrings --- src/base/constants.jl | 4 ++-- src/base/quadrature.jl | 2 +- src/base/util.jl | 4 ++-- src/bem/implicit.jl | 6 ++++-- src/bem/local.jl | 6 +++--- src/format/hmo.jl | 6 +++--- src/format/mcsf.jl | 4 ++-- src/format/msms.jl | 4 ++-- src/format/off.jl | 4 ++-- src/format/pqr.jl | 2 +- src/testmodel/born/model.jl | 2 +- src/testmodel/xie/model.jl | 2 +- 12 files changed, 24 insertions(+), 22 deletions(-) diff --git a/src/base/constants.jl b/src/base/constants.jl index bbbd45a2..90943a5b 100644 --- a/src/base/constants.jl +++ b/src/base/constants.jl @@ -103,10 +103,10 @@ end defaultopt(T::Type{Float64} = Float64) defaultopt(T::Type{Float32}) -Default system parameters +Default system parameters for proteins in water. # Return type -[`Option{T}`](@ref NESSie.Option) +[`Option{T}`](@ref Option) # Default values * ``ε_Ω = 2`` diff --git a/src/base/quadrature.jl b/src/base/quadrature.jl index e86d3542..0c83bc88 100644 --- a/src/base/quadrature.jl +++ b/src/base/quadrature.jl @@ -68,7 +68,7 @@ Generator function for quadrature points: * *Tetrahedra*: 5 points per element [[Kea86]](@ref Bibliography) # Return type -`QuadPts2D` or `QuadPts3D` +[`QuadPts2D`](@ref) or [`QuadPts3D`](@ref) """ quadraturepoints for T in [:Float64, :Float32] varname = Symbol("triquadpts_", T) diff --git a/src/base/util.jl b/src/base/util.jl index 7831bc97..1dc81a8b 100644 --- a/src/base/util.jl +++ b/src/base/util.jl @@ -11,7 +11,7 @@ and area. Returns the completely initialized Triangle as a copy. The given triangle remains unchanged! # Return type -`Triangle` +[`Triangle`](@ref) """ function props(elem::Triangle) # reject degenerate triangles @@ -47,7 +47,7 @@ Merges two volume models, e.g., the models of a protein and the solvent. Duplica and charges (if any) are retained as well as the system constants of the first model. # Return type -`Model{T, Tetrahedron{T}}` +[`Model{T, Tetrahedron{T}}`](@ref) !!! note This function assumes that there are no duplicates within either of the node lists! diff --git a/src/bem/implicit.jl b/src/bem/implicit.jl index 714e5373..c2ac878c 100644 --- a/src/bem/implicit.jl +++ b/src/bem/implicit.jl @@ -99,7 +99,8 @@ Constructs and returns implicit representations for the single- and double-layer potential matrices `V` and `K` for the given observation points and surface elements. # Return type -`Tuple{InteractionMatrix{T}, InteractionMatrix{T}}` +[`Tuple{InteractionMatrix{T}, InteractionMatrix{T}}`] +(https://tkemmer.github.io/ImplicitArrays.jl/stable/#ImplicitArrays.InteractionMatrix) """ @inline function _get_laplace_matrices( Ξ ::Vector{Vector{T}}, @@ -123,7 +124,8 @@ Constructs and returns implicit representations for the single- and double-layer potential matrices `V^Y` and `K^Y` for the given observation points and surface elements. # Return type -`Tuple{InteractionMatrix{T}, InteractionMatrix{T}}` +[`Tuple{InteractionMatrix{T}, InteractionMatrix{T}}`] +(https://tkemmer.github.io/ImplicitArrays.jl/stable/#ImplicitArrays.InteractionMatrix) """ @inline function _get_yukawa_matrices( Ξ::Vector{Vector{T}}, diff --git a/src/bem/local.jl b/src/bem/local.jl index 07a9d7e5..c1e97227 100644 --- a/src/bem/local.jl +++ b/src/bem/local.jl @@ -33,7 +33,7 @@ end Computes the full local or nonlocal cauchy data on the surface of the given biomolecule. # Return type -`LocalBEMResult{T, Triangle{T}}` or `NonlocalBEMResult{T, Triangle{T}}` +[`LocalBEMResult{T, Triangle{T}}`](@ref) or [`NonlocalBEMResult{T, Triangle{T}}`](@ref) # Supported keyword arguments - `method::Symbol = :gmres` @@ -70,7 +70,7 @@ Computes the full local or nonlocal cauchy data on the surface of the biomolecul *explicit* representation of the BEM system. # Return type -`LocalBEMResult{T, Triangle{T}}` or `NonlocalBEMResult{T, Triangle{T}}` +[`LocalBEMResult{T, Triangle{T}}`](@ref) or [`NonlocalBEMResult{T, Triangle{T}}`](@ref) """ function _solve_explicit( ::Type{LocalES}, @@ -199,7 +199,7 @@ Computes the full local or nonlocal cauchy data on the surface of the biomolecul *implicit* representation of the BEM system. # Return type -`LocalBEMResult{T, Triangle{T}}` or `NonlocalBEMResult{T, Triangle{T}}` +[`LocalBEMResult{T, Triangle{T}}`](@ref) or [`NonlocalBEMResult{T, Triangle{T}}`](@ref) """ function _solve_implicit( ::Type{LocalES}, diff --git a/src/format/hmo.jl b/src/format/hmo.jl index a1e6a615..f9412187 100644 --- a/src/format/hmo.jl +++ b/src/format/hmo.jl @@ -8,7 +8,7 @@ Reads a complete surface model from the given HMO file. # Return type -`Model{T, Triangle{T}}` +[`Model{T, Triangle{T}}`](@ref) # Alias @@ -69,7 +69,7 @@ end Reads all elements from the given HMO file. # Return type -`Vector{Triangle{T}}` +[`Vector{Triangle{T}}`](@ref Triangle) """ function readhmo_elements( stream::IOStream, @@ -96,7 +96,7 @@ end Reads all charges from the given HMO file. # Return type -`Vector{Charge{T}}` +[`Vector{Charge{T}}`](@ref Charge) """ function readhmo_charges( stream::IOStream, diff --git a/src/format/mcsf.jl b/src/format/mcsf.jl index b74c845e..d2a5e663 100644 --- a/src/format/mcsf.jl +++ b/src/format/mcsf.jl @@ -17,7 +17,7 @@ Reads a volume model from the given GAMer-generated mcsf file. * `domain` Element domain (solute `:Ω`, solvent `:Σ`, or `:none`) # Return type -`Model{T, Tetrahedron{T}}` +[`Model{T, Tetrahedron{T}}`](@ref) # Aliases @@ -104,7 +104,7 @@ end Reads all elements from the given GAMer-generated mcsf file. # Return type -`Vector{Tetrahedron{T}}` +[`Vector{Tetrahedron{T}}`](@ref Tetrahedron) """ function readmcsf_elements( stream::IOStream, diff --git a/src/format/msms.jl b/src/format/msms.jl index 4765cc0f..eb6b0ca6 100644 --- a/src/format/msms.jl +++ b/src/format/msms.jl @@ -13,7 +13,7 @@ Reads a surface model from the given MSMS-generated `.face` and `.vert` files. `Model` object is empty and has to be set separately. # Return type -`Model{T, Triangle{T}}` +[`Model{T, Triangle{T}}`](@ref) # Alias @@ -76,7 +76,7 @@ end Reads all elements from the given MSMS-generated `.face` file. # Return type -`Vector{Triangle{T}}` +[`Vector{Triangle{T}}`](@ref Triangle) """ function readmsms_elements( stream::IOStream, diff --git a/src/format/off.jl b/src/format/off.jl index 94fc3061..403cfbb6 100644 --- a/src/format/off.jl +++ b/src/format/off.jl @@ -15,7 +15,7 @@ Reads a surface model from the given OFF file. # Return type -`Model{T}` +[`Model{T}`](@ref) # Alias @@ -79,7 +79,7 @@ end Reads the first `n` elements from the given OFF file. # Return type -`Vector{Triangle{T}}` +[`Vector{Triangle{T}}`](@ref Triangle) """ function readoff_elements( stream::IOStream, diff --git a/src/format/pqr.jl b/src/format/pqr.jl index 6d946fc3..e6d29e2b 100644 --- a/src/format/pqr.jl +++ b/src/format/pqr.jl @@ -11,7 +11,7 @@ Reads a charge model from the given PQR file. # Return type -`Vector{Charge{T}}` +[`Vector{Charge{T}}`](@ref Charge) # Alias diff --git a/src/testmodel/born/model.jl b/src/testmodel/born/model.jl index 57d56431..5dfb6638 100644 --- a/src/testmodel/born/model.jl +++ b/src/testmodel/born/model.jl @@ -43,7 +43,7 @@ Generator function for built-in Born ions: | Ba | +2 | 1.385 | ## Return type -`BornIon` +[`BornIon{T}`](@ref) """ bornion for T in [:Float64, :Float32] varname = Symbol("bornions_", T) diff --git a/src/testmodel/xie/model.jl b/src/testmodel/xie/model.jl index 5d76a7c4..f6749fb9 100644 --- a/src/testmodel/xie/model.jl +++ b/src/testmodel/xie/model.jl @@ -68,7 +68,7 @@ located at 80% `radius` distance from the origin. the results to the reference. # Return type -`Vector{Charge{T}}` +[`Vector{Charge{T}}`](@ref Charge) """ function scalemodel( charges::Vector{Charge{T}}, From 5b5dc46d0440681034c2efe68dec5be778616b61 Mon Sep 17 00:00:00 2001 From: Thomas Kemmer Date: Wed, 12 Feb 2025 11:07:20 +0100 Subject: [PATCH 3/6] Docs: fix {Void => Nothing} in docstrings --- src/Radon.jl | 4 ++-- src/Rjasanow.jl | 2 +- src/base/util.jl | 2 +- src/format/hmo.jl | 2 +- src/format/obj.jl | 2 +- src/format/skel.jl | 2 +- src/format/stl.jl | 2 +- src/format/vtk.jl | 2 +- src/format/xml3d.jl | 4 ++-- 9 files changed, 11 insertions(+), 11 deletions(-) diff --git a/src/Radon.jl b/src/Radon.jl index e12aee81..61573bf0 100644 --- a/src/Radon.jl +++ b/src/Radon.jl @@ -163,7 +163,7 @@ to use the shorthand signature `regularyukawacoll!` instead. * `yukawa` [Exponent](@ref int-constants) of the Yukawa operator's fundamental solution # Return type -`Void` +`Nothing` """ function radoncoll!( dest ::AbstractVector{T}, @@ -306,7 +306,7 @@ vector. * `yukawa` [Exponent](@ref int-constants) of the Yukawa operator's fundamental solution # Return type -`Void` +`Nothing` """ @inline regularyukawacoll!( ::Type{SingleLayer}, diff --git a/src/Rjasanow.jl b/src/Rjasanow.jl index 8eaa7323..3fc43ed4 100644 --- a/src/Rjasanow.jl +++ b/src/Rjasanow.jl @@ -282,7 +282,7 @@ vector. The result is premultiplied by 4π. # Return type -`Void` +`Nothing` """ function laplacecoll!( ptype ::Type{P}, diff --git a/src/base/util.jl b/src/base/util.jl index 1dc81a8b..385aaeb3 100644 --- a/src/base/util.jl +++ b/src/base/util.jl @@ -176,7 +176,7 @@ is no such line, the stream handle will be set to EOF. * `skiptheline` If true, said line will also be skipped # Return type -`Void` +`Nothing` """ function _seek(fh::IOStream, prefix::String, skiptheline::Bool=true) m = -1 diff --git a/src/format/hmo.jl b/src/format/hmo.jl index f9412187..ab292de9 100644 --- a/src/format/hmo.jl +++ b/src/format/hmo.jl @@ -123,7 +123,7 @@ end Creates a HMO file from the given surface model. # Return type -`Void` +`Nothing` # Alias diff --git a/src/format/obj.jl b/src/format/obj.jl index abc2cdae..09975ff9 100644 --- a/src/format/obj.jl +++ b/src/format/obj.jl @@ -12,7 +12,7 @@ Creates a Wavefront OBJ file from a given surface model. # Return type -`Void` +`Nothing` # Alias diff --git a/src/format/skel.jl b/src/format/skel.jl index 220c6bdb..50019e2a 100644 --- a/src/format/skel.jl +++ b/src/format/skel.jl @@ -12,7 +12,7 @@ collection of points and polylines. # Return type -`Void` +`Nothing` # Alias diff --git a/src/format/stl.jl b/src/format/stl.jl index 306bc8da..e0db23dd 100644 --- a/src/format/stl.jl +++ b/src/format/stl.jl @@ -78,7 +78,7 @@ Creates a binary STL file from a given surface model. # Return type -`Void` +`Nothing` # Alias diff --git a/src/format/vtk.jl b/src/format/vtk.jl index b4125157..abe27a87 100644 --- a/src/format/vtk.jl +++ b/src/format/vtk.jl @@ -17,7 +17,7 @@ type is determined by the given model: # Return type -`Void` +`Nothing` # Alias diff --git a/src/format/xml3d.jl b/src/format/xml3d.jl index 5ffcefd8..89e18454 100644 --- a/src/format/xml3d.jl +++ b/src/format/xml3d.jl @@ -12,7 +12,7 @@ latter as point cloud) or from a given surface model. # Return type -`Void` +`Nothing` # Alias @@ -96,7 +96,7 @@ as point cloud. # Return type -`Void` +`Nothing` # Alias From 03f5ad74e73dba5ce429ddd1f20ec445405e9439 Mon Sep 17 00:00:00 2001 From: Thomas Kemmer Date: Wed, 12 Feb 2025 11:57:00 +0100 Subject: [PATCH 4/6] Docs: add module context to all doc files --- docs/src/lib/constants.md | 3 +++ docs/src/lib/electrostatics.md | 15 +++++++++------ docs/src/lib/models.md | 3 +++ docs/src/lib/quadrature.md | 11 +++++++---- docs/src/lib/solvers.md | 3 +++ 5 files changed, 25 insertions(+), 10 deletions(-) diff --git a/docs/src/lib/constants.md b/docs/src/lib/constants.md index 406f833c..c4863ca8 100644 --- a/docs/src/lib/constants.md +++ b/docs/src/lib/constants.md @@ -1,4 +1,7 @@ # Constants +```@meta + CurrentModule = NESSie +``` ## Global constants ```@docs diff --git a/docs/src/lib/electrostatics.md b/docs/src/lib/electrostatics.md index 48bcb140..96535091 100644 --- a/docs/src/lib/electrostatics.md +++ b/docs/src/lib/electrostatics.md @@ -1,4 +1,7 @@ # Electrostatics +```@meta + CurrentModule = NESSie +``` ## Potential types ```@docs @@ -20,23 +23,23 @@ ```@docs φmol ∂ₙφmol - NESSie.∇φmol + ∇φmol ``` ### Interior potentials ```@docs - NESSie.BEM.φΩ - NESSie.TestModel.φΩ + BEM.φΩ + TestModel.φΩ ``` ### Exterior potentials ```@docs - NESSie.BEM.φΣ - NESSie.TestModel.φΣ + BEM.φΣ + TestModel.φΣ ``` ## Energies ```@docs - NESSie.BEM.rfenergy + BEM.rfenergy ``` diff --git a/docs/src/lib/models.md b/docs/src/lib/models.md index 760f76c8..81e91beb 100644 --- a/docs/src/lib/models.md +++ b/docs/src/lib/models.md @@ -1,4 +1,7 @@ # Models +```@meta + CurrentModule = NESSie +``` ## Elements ```@docs diff --git a/docs/src/lib/quadrature.md b/docs/src/lib/quadrature.md index 39842bb1..bef85bd4 100644 --- a/docs/src/lib/quadrature.md +++ b/docs/src/lib/quadrature.md @@ -1,4 +1,7 @@ # Quadrature +```@meta + CurrentModule = NESSie +``` ## Quadrature points ```@docs @@ -20,12 +23,12 @@ ## Laplace potential ```@docs - NESSie.Rjasanow.laplacecoll - NESSie.Rjasanow.laplacecoll! + Rjasanow.laplacecoll + Rjasanow.laplacecoll! ``` ## Yukawa potential ```@docs - NESSie.Radon.regularyukawacoll - NESSie.Radon.regularyukawacoll! + Radon.regularyukawacoll + Radon.regularyukawacoll! ``` diff --git a/docs/src/lib/solvers.md b/docs/src/lib/solvers.md index 028537e7..695cf472 100644 --- a/docs/src/lib/solvers.md +++ b/docs/src/lib/solvers.md @@ -1,4 +1,7 @@ # Solvers +```@meta + CurrentModule = NESSie +``` ## BEM solvers ```@meta From 7d7341d58d379411cf6d94658426cfd20501dabe Mon Sep 17 00:00:00 2001 From: Thomas Kemmer Date: Wed, 12 Feb 2025 11:57:54 +0100 Subject: [PATCH 5/6] Docs: include extension docstrings --- docs/Project.toml | 3 ++- docs/make.jl | 10 ++++++++-- docs/src/lib/util.md | 1 + ext/GeometryBasicsExt.jl | 10 ++++++++++ 4 files changed, 21 insertions(+), 3 deletions(-) diff --git a/docs/Project.toml b/docs/Project.toml index c290e608..3743279a 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -1,7 +1,8 @@ [deps] Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" +GeometryBasics = "5c1252a2-5f33-56bf-86c9-59e7332b4326" NESSie = "f00e83c4-bd01-11e9-272c-ff1b96fb444d" [compat] Documenter = "1" -julia = "1.6" +julia = "1.10" diff --git a/docs/make.jl b/docs/make.jl index a45c37d4..ba2ba6f4 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,4 +1,4 @@ -using Documenter, NESSie +using Documenter, GeometryBasics, NESSie const pages = [ "Home" => "index.md", @@ -25,7 +25,13 @@ const pages = [ ] makedocs( - modules = [NESSie, NESSie.BEM, NESSie.Format, NESSie.TestModel], + modules = [ + NESSie, + NESSie.BEM, + NESSie.Format, + NESSie.TestModel, + Base.get_extension(NESSie, :GeometryBasicsExt) + ], clean = true, doctest = true, linkcheck = true, diff --git a/docs/src/lib/util.md b/docs/src/lib/util.md index e1a12c7d..76a75be1 100644 --- a/docs/src/lib/util.md +++ b/docs/src/lib/util.md @@ -4,4 +4,5 @@ meshunion obspoints_line obspoints_plane + GeometryBasics.mesh ``` diff --git a/ext/GeometryBasicsExt.jl b/ext/GeometryBasicsExt.jl index 7fe1c967..f47bcc4d 100644 --- a/ext/GeometryBasicsExt.jl +++ b/ext/GeometryBasicsExt.jl @@ -4,6 +4,16 @@ import GeometryBasics using NESSie +""" + GeometryBasics.mesh(model::Model{T, Triangle{T}}) + +Converts the given model into a GeometryBasics.jl-compatible mesh, e.g., for visualization +through [Makie.jl](https://docs.makie.org/stable/reference/plots/mesh). + +# Return type +[`GeometryBasics.Mesh`] +(https://juliageometry.github.io/GeometryBasics.jl/stable/meshes/#GeometryBasics.Mesh-meshes) +""" function GeometryBasics.mesh(model::Model{T, Triangle{T}}) where T ridx = NESSie._reverseindex(model.nodes) From df0421ae944caac957bb3ced2d11455696241139 Mon Sep 17 00:00:00 2001 From: Thomas Kemmer Date: Wed, 12 Feb 2025 12:05:12 +0100 Subject: [PATCH 6/6] Docs: add indices to most doc files --- docs/src/intern/base.md | 4 ++++ docs/src/intern/bem.md | 4 ++++ docs/src/intern/format.md | 4 ++++ docs/src/intern/radon.md | 5 +++++ docs/src/intern/rjasanow.md | 4 ++++ docs/src/intern/testmodel.md | 4 ++++ docs/src/lib/constants.md | 4 ++++ docs/src/lib/electrostatics.md | 4 ++++ docs/src/lib/models.md | 4 ++++ docs/src/lib/quadrature.md | 4 ++++ docs/src/lib/solvers.md | 4 ++++ docs/src/lib/util.md | 4 ++++ 12 files changed, 49 insertions(+) diff --git a/docs/src/intern/base.md b/docs/src/intern/base.md index f2a3ad00..06b230a9 100644 --- a/docs/src/intern/base.md +++ b/docs/src/intern/base.md @@ -3,6 +3,10 @@ CurrentModule = NESSie ``` +```@index +Pages = ["base.md"] +``` + ## [Constants](@id int-constants) ```@docs _etol diff --git a/docs/src/intern/bem.md b/docs/src/intern/bem.md index f8b9391d..cccb0ef8 100644 --- a/docs/src/intern/bem.md +++ b/docs/src/intern/bem.md @@ -3,6 +3,10 @@ CurrentModule = NESSie.BEM ``` +```@index +Pages = ["bem.md"] +``` + ## Solvers ``` @docs _get_laplace_matrices diff --git a/docs/src/intern/format.md b/docs/src/intern/format.md index e8d1b207..339a0ea3 100644 --- a/docs/src/intern/format.md +++ b/docs/src/intern/format.md @@ -3,6 +3,10 @@ CurrentModule = NESSie.Format ``` +```@index +Pages = ["format.md"] +``` + ## [Input formats](@id int-input) ```@docs readhmo_nodes diff --git a/docs/src/intern/radon.md b/docs/src/intern/radon.md index 4748ac93..32f02e63 100644 --- a/docs/src/intern/radon.md +++ b/docs/src/intern/radon.md @@ -3,6 +3,11 @@ CurrentModule = NESSie.Radon ``` +```@index +Pages = ["radon.md"] +``` + + ```@docs radoncoll radoncoll! diff --git a/docs/src/intern/rjasanow.md b/docs/src/intern/rjasanow.md index a407c2bd..81d5ab5f 100644 --- a/docs/src/intern/rjasanow.md +++ b/docs/src/intern/rjasanow.md @@ -3,6 +3,10 @@ CurrentModule = NESSie.Rjasanow ``` +```@index +Pages = ["rjasanow.md"] +``` + ```@docs ObservationPosition InPlane diff --git a/docs/src/intern/testmodel.md b/docs/src/intern/testmodel.md index 1605b07e..66416ec6 100644 --- a/docs/src/intern/testmodel.md +++ b/docs/src/intern/testmodel.md @@ -3,6 +3,10 @@ CurrentModule = NESSie.TestModel ``` +```@index +Pages = ["testmodel.md"] +``` + ## [Utility functions](@id int-util-testmodel) ```@docs coefficients diff --git a/docs/src/lib/constants.md b/docs/src/lib/constants.md index c4863ca8..e1aa2451 100644 --- a/docs/src/lib/constants.md +++ b/docs/src/lib/constants.md @@ -3,6 +3,10 @@ CurrentModule = NESSie ``` +```@index +Pages = ["constants.md"] +``` + ## Global constants ```@docs ε0 diff --git a/docs/src/lib/electrostatics.md b/docs/src/lib/electrostatics.md index 96535091..42e363b3 100644 --- a/docs/src/lib/electrostatics.md +++ b/docs/src/lib/electrostatics.md @@ -3,6 +3,10 @@ CurrentModule = NESSie ``` +```@index +Pages = ["electrostatics.md"] +``` + ## Potential types ```@docs PotentialType diff --git a/docs/src/lib/models.md b/docs/src/lib/models.md index 81e91beb..0d476779 100644 --- a/docs/src/lib/models.md +++ b/docs/src/lib/models.md @@ -3,6 +3,10 @@ CurrentModule = NESSie ``` +```@index +Pages = ["models.md"] +``` + ## Elements ```@docs Element diff --git a/docs/src/lib/quadrature.md b/docs/src/lib/quadrature.md index bef85bd4..bcf84c52 100644 --- a/docs/src/lib/quadrature.md +++ b/docs/src/lib/quadrature.md @@ -3,6 +3,10 @@ CurrentModule = NESSie ``` +```@index +Pages = ["quadrature.md"] +``` + ## Quadrature points ```@docs QuadraturePoints diff --git a/docs/src/lib/solvers.md b/docs/src/lib/solvers.md index 695cf472..686b0e14 100644 --- a/docs/src/lib/solvers.md +++ b/docs/src/lib/solvers.md @@ -3,6 +3,10 @@ CurrentModule = NESSie ``` +```@index +Pages = ["solvers.md"] +``` + ## BEM solvers ```@meta CurrentModule = NESSie.BEM diff --git a/docs/src/lib/util.md b/docs/src/lib/util.md index 76a75be1..1044faeb 100644 --- a/docs/src/lib/util.md +++ b/docs/src/lib/util.md @@ -1,5 +1,9 @@ # Utility functions +```@index +Pages = ["util.md"] +``` + ```@docs meshunion obspoints_line