Skip to content

Commit

Permalink
Docs: add module context to all doc files
Browse files Browse the repository at this point in the history
  • Loading branch information
tkemmer committed Feb 12, 2025
1 parent 5b5dc46 commit 03f5ad7
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 10 deletions.
3 changes: 3 additions & 0 deletions docs/src/lib/constants.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Constants
```@meta
CurrentModule = NESSie
```

## Global constants
```@docs
Expand Down
15 changes: 9 additions & 6 deletions docs/src/lib/electrostatics.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Electrostatics
```@meta
CurrentModule = NESSie
```

## Potential types
```@docs
Expand All @@ -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
```
3 changes: 3 additions & 0 deletions docs/src/lib/models.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Models
```@meta
CurrentModule = NESSie
```

## Elements
```@docs
Expand Down
11 changes: 7 additions & 4 deletions docs/src/lib/quadrature.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Quadrature
```@meta
CurrentModule = NESSie
```

## Quadrature points
```@docs
Expand All @@ -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!
```
3 changes: 3 additions & 0 deletions docs/src/lib/solvers.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Solvers
```@meta
CurrentModule = NESSie
```

## BEM solvers
```@meta
Expand Down

0 comments on commit 03f5ad7

Please # to comment.