reorganize docstrings into proper sections

m3g · May 2, 2024 · 4668c47 · 4668c47
1 parent e587c53
commit 4668c47
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 18 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -12,7 +12,6 @@ makedocs(
         "Low level interface" => "LowLevel.md",
         "Ecosystem integration" => "ecosystem.md",
         "From Python" => "python.md",
-        "Help entries" => "help.md",
         "Citation" => "citation.md",
     ]
 )

diff --git a/docs/src/LowLevel.md b/docs/src/LowLevel.md
@@ -602,6 +602,20 @@ julia> map_pairwise!((x,y,i,j,d2,n) -> n += 1, 0, box, cl) # count neighbors
 23
 ```
 
+## Docstrings
+
+```@meta
+CollapsedDocStrings = true
+```
+
+```@autodocs
+Modules = [CellListMap]
+Pages = ["Box.jl", "CellListMap.jl", "CellLists.jl", "CellOperations.jl", "CoreComputing.jl"]
+Order = [:type, :function]
+```
+
+
+
 
 
 
diff --git a/docs/src/ParticleSystem.md b/docs/src/ParticleSystem.md
@@ -895,3 +895,15 @@ function animate(trajectory)
 end
 ```
 
+## Docstrings
+
+```@meta
+CollapsedDocStrings = true
+```
+
+```@autodocs
+Modules = [CellListMap]
+Pages = ["ParticleSystem.jl"]
+Order = [:function, :type]
+```
+
diff --git a/docs/src/help.md b/docs/src/help.md
diff --git a/docs/src/neighborlists.md b/docs/src/neighborlists.md
@@ -197,5 +197,17 @@ Additional optional parameters can be used in a `neighborlist` call:
 | `autoswap` | `Bool` | `true` |  (advanced) automatically choose set to construct the cell lists |
 
 
+## Docstrings
+
+```@meta
+CollapsedDocStrings = true
+```
+
+```@autodocs
+Modules = [CellListMap]
+Pages = ["neighborlists.jl"]
+Order = [:function, :type]
+```
+