From 984b8be0b9ca07e8803046453b83abf79b3aa678 Mon Sep 17 00:00:00 2001 From: Alec Loudenback Date: Fri, 27 Oct 2023 21:48:12 -0500 Subject: [PATCH 1/2] update for Documenter 1.0 --- .gitignore | 4 ++-- docs/Project.toml | 3 +++ docs/make.jl | 11 +++++------ 3 files changed, 10 insertions(+), 8 deletions(-) create mode 100644 docs/Project.toml diff --git a/.gitignore b/.gitignore index 19e15f5..1e8e169 100644 --- a/.gitignore +++ b/.gitignore @@ -24,5 +24,5 @@ docs/site/ Manifest.toml # other -~*.xlsx -*.DS_Store \ No newline at end of file +*.DS_Store +settings.json \ No newline at end of file diff --git a/docs/Project.toml b/docs/Project.toml new file mode 100644 index 0000000..066e291 --- /dev/null +++ b/docs/Project.toml @@ -0,0 +1,3 @@ +[deps] +Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" +LifeContingencies = "c8f0d631-89cd-4a1f-93d0-7542c3692561" diff --git a/docs/make.jl b/docs/make.jl index 7b36648..7712f24 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -3,19 +3,18 @@ using Documenter, LifeContingencies makedocs(; modules=[LifeContingencies], format=Documenter.HTML(; - prettyurls=get(ENV, "CI", "false") == "true", - canonical="https://JuliaActuary.github.io/Yields.jl", - assets=String[], + prettyurls=get(ENV, "CI", "false") == "true", + assets=String[] ), pages=[ "Home" => "index.md", "API Reference" => "api.md", ], - repo="https://github.com/JuliaActuary/LifeContingencies.jl/blob/{commit}{path}#L{line}", + repo=Remotes.GitHub("JuliaActuary", "LifeContingencies.jl"), sitename="LifeContingencies.jl", - authors="Alec Loudenback and contributors", + authors="Alec Loudenback and contributors" ) deploydocs(; - repo="github.com/JuliaActuary/LifeContingencies.jl", + repo="github.com/JuliaActuary/LifeContingencies.jl" ) \ No newline at end of file From 390f14ed53a346b59bd4394a0b1168f5b6da1a91 Mon Sep 17 00:00:00 2001 From: Alec Loudenback Date: Fri, 27 Oct 2023 21:49:52 -0500 Subject: [PATCH 2/2] organize API page --- docs/src/api.md | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/docs/src/api.md b/docs/src/api.md index f19016a..9543890 100644 --- a/docs/src/api.md +++ b/docs/src/api.md @@ -1,21 +1,19 @@ -# API Reference +# LifeContingencies API Reference ```@index +Modules = [LifeContingencies] ``` -```@meta +## Exported API +```@autodocs +Modules = [LifeContingencies] +Private = false ``` +## Unexported API ```@autodocs Modules = [LifeContingencies] - +Public = false ``` -```@raw html - - -``` \ No newline at end of file + +Please [open an issue](https://github.com/JuliaActuary/LifeContingencies.jl/issues) if you encounter any issues or confusion with the package.