diff --git a/EpiAware/docs/pages.jl b/EpiAware/docs/pages.jl index ed7a167b0..4bdf11e1c 100644 --- a/EpiAware/docs/pages.jl +++ b/EpiAware/docs/pages.jl @@ -12,10 +12,7 @@ pages = [ "Developers" => [ "contributing.md", "checklists.md", - "Internals" => map( - s -> "lib/internals/$(s)", - sort(readdir(joinpath(@__DIR__, "src/lib/internals"))) - ) + "Internals" => "lib/internals.md" ], "release-notes.md" ] diff --git a/EpiAware/docs/src/lib/internals.md b/EpiAware/docs/src/lib/internals.md index e69de29bb..57ae28f36 100644 --- a/EpiAware/docs/src/lib/internals.md +++ b/EpiAware/docs/src/lib/internals.md @@ -0,0 +1,23 @@ +# internal Documentation + +Documentation for `EpiAware.jl`'s internal interface. + +## Contents + +```@contents +Pages = ["internal.md"] +Depth = 2:2 +``` + +## Index + +```@index +Pages = ["internals.md"] +``` + +## Internal API + +```@autodocs +Modules = [EpiAware] +Public = false +``` diff --git a/EpiAware/docs/src/lib/public.md b/EpiAware/docs/src/lib/public.md index 4a89ab72a..1ddcd80c3 100644 --- a/EpiAware/docs/src/lib/public.md +++ b/EpiAware/docs/src/lib/public.md @@ -16,36 +16,10 @@ Depth = 2:2 ```@index Pages = ["public.md"] ``` -## Modules -```@docs -EpiAware -``` - -## Abstract types - -```@docs -AbstractModel -AbstractEpiModel -AbstractLatentModel -AbstractObservationModel -``` - -## Types - -```@docs -EpiData -Renewal -ExpGrowthRate -DirectInfections -RandomWalk -``` - -## Functions +## Public API -```@docs -make_epi_aware -create_discrete_pmf -spread_draws -scan +```@autodocs +Modules = [EpiAware] +Private = false ```