Skip to content

Commit

Permalink
clean up API exposure
Browse files Browse the repository at this point in the history
  • Loading branch information
seabbs committed Jul 1, 2024
1 parent 249974d commit 0109c23
Show file tree
Hide file tree
Showing 22 changed files with 353 additions and 36 deletions.
12 changes: 10 additions & 2 deletions EpiAware/docs/pages.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,17 @@ pages = [
"Getting started" => "examples/getting_started.md"
]
],
"Reference" => Any[
"Public API" => "lib/public.md"
"Modules" => [
"EpiAware" => "lib/EpiAwareBase/index.md",
"EpiAwareUtils" => "lib/EpiAwareUtils/index.md",
"EpiInference" => "lib/EpiInference/index.md",
"EpiInfModels" => "lib/EpiInfModels/index.md",
"EpiLatentModels" => "lib/EpiLatentModels/index.md",
"EpiObsModels" => "lib/EpiObsModels/index.md"
],
"Reference" => Any[
"Public API" => "lib/public.md",
"Internal API" => "lib/internals.md"],
"Developers" => [
"Contributing" => "man/contributing.md",
"Release checklist" => "checklist.md",
Expand Down
9 changes: 9 additions & 0 deletions EpiAware/docs/src/lib/EpiAwareBase/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# EpiAwareBase.jl

This package provides the core functionality for the EpiAware ecosystem. It is a dependency of all other EpiAware packages.

## API

```@contents
Pages = ["lib/EpiAwareBase/public.md", "lib/EpiAwareBase/internals.md"]
```
23 changes: 23 additions & 0 deletions EpiAware/docs/src/lib/EpiAwareBase/internals.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Internal Documentation

Documentation for `EpiAwareBase.jl`'s internal interface.

## Contents

```@contents
Pages = ["internals.md"]
Depth = 2:2
```

## Index

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

## Internal API

```@autodocs
Modules = [EpiAware.EpiAwareBase]
Public = false
```
25 changes: 25 additions & 0 deletions EpiAware/docs/src/lib/EpiAwareBase/public.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Public Documentation

Documentation for `EpiAwareBae.jl`'s public interface.

See the Internals section of the manual for internal package docs covering all submodules.

## Contents

```@contents
Pages = ["public.md"]
Depth = 2:2
```

## Index

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

## Public API

```@autodocs
Modules = [EpiAware.EpiAwareBase]
Private = false
```
9 changes: 9 additions & 0 deletions EpiAware/docs/src/lib/EpiAwareUtils/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# EpiAwareUtils.jl

This package provides utility functions for the EpiAware ecosystem.

## API

```@contents
Pages = ["lib/EpiAwareUtils/public.md", "lib/EpiAwareUtils/internals.md"]
```
23 changes: 23 additions & 0 deletions EpiAware/docs/src/lib/EpiAwareUtils/internals.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Internal Documentation

Documentation for `EpiAwareUtils.jl`'s internal interface.

## Contents

```@contents
Pages = ["internals.md"]
Depth = 2:2
```

## Index

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

## Internal API

```@autodocs
Modules = [EpiAware.EpiAwareUtils]
Public = false
```
25 changes: 25 additions & 0 deletions EpiAware/docs/src/lib/EpiAwareUtils/public.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Public Documentation

Documentation for `EpiAwareBae.jl`'s public interface.

See the Internals section of the manual for internal package docs covering all submodules.

## Contents

```@contents
Pages = ["public.md"]
Depth = 2:2
```

## Index

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

## Public API

```@autodocs
Modules = [EpiAware.EpiAwareBase]
Private = false
```
9 changes: 9 additions & 0 deletions EpiAware/docs/src/lib/EpiInfModels/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# EpiInfModels.jl

This package provides infectious disease transmission models for the `EpiAware` ecosystem.

## API

```@contents
Pages = ["lib/EpiInfModels/public.md", "lib/EpiInfModels/internals.md"]
```
23 changes: 23 additions & 0 deletions EpiAware/docs/src/lib/EpiInfModels/internals.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Internal Documentation

Documentation for `EpiInfModels.jl`'s internal interface.

## Contents

```@contents
Pages = ["internals.md"]
Depth = 2:2
```

## Index

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

## Internal API

```@autodocs
Modules = [EpiAware.EpiInfModels]
Public = false
```
25 changes: 25 additions & 0 deletions EpiAware/docs/src/lib/EpiInfModels/public.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Public Documentation

Documentation for `EpiInfModels.jl`'s public interface.

See the Internals section of the manual for internal package docs covering all submodules.

## Contents

```@contents
Pages = ["public.md"]
Depth = 2:2
```

## Index

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

## Public API

```@autodocs
Modules = [EpiAware.EpiInfModels]
Private = false
```
9 changes: 9 additions & 0 deletions EpiAware/docs/src/lib/EpiInference/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# EpiInference.jl

This package provides inference algorithms for the `EpiAware` ecosystem.

## API

```@contents
Pages = ["lib/EpiInference/public.md", "lib/EpiInference/internals.md"]
```
23 changes: 23 additions & 0 deletions EpiAware/docs/src/lib/EpiInference/internals.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Internal Documentation

Documentation for `EpInference.jl`'s internal interface.

## Contents

```@contents
Pages = ["internals.md"]
Depth = 2:2
```

## Index

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

## Internal API

```@autodocs
Modules = [EpiInference]
Public = false
```
25 changes: 25 additions & 0 deletions EpiAware/docs/src/lib/EpiInference/public.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Public Documentation

Documentation for `EpiInference.jl`'s public interface.

See the Internals section of the manual for internal package docs covering all submodules.

## Contents

```@contents
Pages = ["public.md"]
Depth = 2:2
```

## Index

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

## Public API

```@autodocs
Modules = [EpiAware.EpiAwareInference]
Private = false
```
9 changes: 9 additions & 0 deletions EpiAware/docs/src/lib/EpiLatentModels/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# EpiLatentModels.jl

This package provides latent variable models for the `EpiAware` ecosystem.

## API

```@contents
Pages = ["lib/EpiLatentModels/public.md", "lib/EpiLatentModels/internals.md"]
```
23 changes: 23 additions & 0 deletions EpiAware/docs/src/lib/EpiLatentModels/internals.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Internal Documentation

Documentation for `EpiLatentModels.jl`'s internal interface.

## Contents

```@contents
Pages = ["internals.md"]
Depth = 2:2
```

## Index

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

## Internal API

```@autodocs
Modules = [EpiAware.EpiLatentModels]
Public = false
```
25 changes: 25 additions & 0 deletions EpiAware/docs/src/lib/EpiLatentModels/public.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Public Documentation

Documentation for `EpiLatentModels.jl`'s public interface.

See the Internals section of the manual for internal package docs covering all submodules.

## Contents

```@contents
Pages = ["public.md"]
Depth = 2:2
```

## Index

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

## Public API

```@autodocs
Modules = [EpiAware.EpiLatentModels]
Private = false
```
9 changes: 9 additions & 0 deletions EpiAware/docs/src/lib/EpiObsModels/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# EpiObsModels.jl

This package provides observation models for the `EpiAware` ecosystem.

## API

```@contents
Pages = ["lib/EpiObsModels/public.md", "lib/EpiObsModels/internals.md"]
```
23 changes: 23 additions & 0 deletions EpiAware/docs/src/lib/EpiObsModels/internals.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Internal Documentation

Documentation for `EpiObsModels.jl`'s internal interface.

## Contents

```@contents
Pages = ["internals.md"]
Depth = 2:2
```

## Index

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

## Internal API

```@autodocs
Modules = [EpiAware.EpiObsModels]
Public = false
```
25 changes: 25 additions & 0 deletions EpiAware/docs/src/lib/EpiObsModels/public.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Public Documentation

Documentation for `EpiObsModels.jl`'s public interface.

See the Internals section of the manual for internal package docs covering all submodules.

## Contents

```@contents
Pages = ["public.md"]
Depth = 2:2
```

## Index

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

## Public API

```@autodocs
Modules = [EpiAware.EpiObsModels]
Private = false
```
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# internal Documentation
# Internal Documentation

Documentation for `EpiAware.jl`'s internal interface.

Expand Down
File renamed without changes.
Loading

0 comments on commit 0109c23

Please sign in to comment.