Skip to content

Commit

Permalink
refine docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JTHesse committed Oct 23, 2024
1 parent b74a1f5 commit e92ceb2
Show file tree
Hide file tree
Showing 15 changed files with 174 additions and 440 deletions.
14 changes: 7 additions & 7 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,13 @@ makedocs(
"Module integration"=>"man/dev/module_integration.md",
],
"API"=>Any[
# "Types" => "lib/types.md",
"Functions"=>"lib/functions.md",
"IO Functions"=>"lib/io_functions.md",
"MPI Functions"=>"lib/mpi_functions.md",
"Models Functions"=>"lib/models_functions.md",
# "Indexing" => "lib/indexing.md",
# "Metadata" => "lib/metadata.md",
"Model Factory"=>"lib/model_factory_functions.md",
"Data Manager"=>"lib/data_manager_functions.md",
"Solver"=>"lib/solver_functions.md",
"IO"=>"lib/io_functions.md",
"MPI"=>"lib/mpi_functions.md",
"Helper"=>"lib/helper_functions.md",
"Logging"=>"lib/logging_functions.md",
# hide("Internals" => "lib/internals.md"),
],
],
Expand Down
18 changes: 18 additions & 0 deletions docs/src/lib/data_manager_functions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Data Manager - Functions

## Index

```@index
Pages = ["data_manager_functions.md"]
```

```@meta
CurrentModule = PeriLab
```

## Data_manager

```@autodocs
Modules = [Data_manager]
Order = [:function, :type]
```
File renamed without changes.
121 changes: 0 additions & 121 deletions docs/src/lib/functions.md

This file was deleted.

18 changes: 18 additions & 0 deletions docs/src/lib/helper_functions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Helper - Functions

## Index

```@index
Pages = ["helper_functions.md"]
```

```@meta
CurrentModule = PeriLab
```

## Helpers

```@autodocs
Modules = [Solver.Helpers]
Order = [:function, :type]
```
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
SPDX-FileCopyrightText: 2023 Christian Willberg <[email protected]>, Jan-Timo Hesse <[email protected]>

SPDX-License-Identifier: BSD-3-Clause
SPDX-License-Identifier: BSD-3-Clause
Loading

0 comments on commit e92ceb2

Please sign in to comment.