diff --git a/docs/make.jl b/docs/make.jl index 186f47ad..3035e25f 100644 --- 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 index c0e55e62..fddd8486 100644 --- 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 index a788d26f..3c6a401c 100644 --- 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 deleted file mode 100644 index f82038f5..00000000 --- a/docs/src/help.md +++ /dev/null @@ -1,17 +0,0 @@ - -```@meta -CollapsedDocStrings = true -``` - -# Help entries - -These entries can be viewed at the `Julia` REPL `Julia` using - -```julia-repl -julia> ? -help?> function_name -``` - -```@autodocs -Modules=[CellListMap] -``` \ No newline at end of file diff --git a/docs/src/neighborlists.md b/docs/src/neighborlists.md index 44d73135..3f254abd 100644 --- 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] +``` +