update docs for Documenter 1.0

JuliaActuary · Oct 28, 2023 · a757004 · a757004
1 parent 505db36
commit a757004
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 14 deletions.
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -0,0 +1,3 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+MortalityTables = "4780e19d-04b9-53dc-86c2-9e9aa59b5a12"
diff --git a/docs/make.jl b/docs/make.jl
@@ -14,11 +14,11 @@ makedocs(;
         ],
         "Reference" => "Reference.md",
     ],
-    repo="https://github.com/JuliaActuary/MortalityTables.jl/blob/{commit}{path}#L{line}",
+    repo=Remotes.GitHub("JuliaActuary", "MortalityTables.jl"),
     sitename="MortalityTables.jl",
-    authors="Alec Loudenback",
+    authors="Alec Loudenback"
 )
 
 deploydocs(;
-    repo="github.com/JuliaActuary/MortalityTables.jl",
+    repo="github.com/JuliaActuary/MortalityTables.jl"
 )
diff --git a/docs/src/ParametricMortalityModels.md b/docs/src/ParametricMortalityModels.md
@@ -68,7 +68,7 @@ Modules = [MortalityTables]
 Order   = [:type]
 ```
 
-```@docs
+```@docs; canonical=false
 MortalityTables.Makeham
 MortalityTables.Gompertz
 MortalityTables.InverseGompertz

diff --git a/docs/src/Reference.md b/docs/src/Reference.md
@@ -2,3 +2,7 @@
 
 ```@index
 ```
+
+```@autodocs
+Modules = [MortalityTables]
+```
diff --git a/docs/src/Tables.md b/docs/src/Tables.md
@@ -133,7 +133,7 @@ my_table = MortalityTable(
               )
 ```
 
-```@docs
+```@docs; canonical=false
 MortalityTables.readXTbML
 MortalityTables.table
 MortalityTables.get_SOA_table
@@ -143,7 +143,7 @@ MortalityTables.get_SOA_table
 
 Use these to build your own `MortalityTables.jl`-compatible table:
 
-```@docs
+```@docs; canonical=false
 MortalityTables.MortalityTable
 MortalityTables.SelectMortality
 MortalityTables.UltimateMortality
@@ -154,13 +154,13 @@ MortalityTables.mortality_vector
 
 Basic metadata about the table (automatically populated for some tables).
 
-```@docs
+```@docs; canonical=false
 MortalityTables.TableMetaData
 ```
 
 Find the final age for which a table defines a rate.
 
-```@docs
+```@docs; canonical=false
 MortalityTables.omega
 ```
 
@@ -216,11 +216,11 @@ julia> vbt2001.ultimate[95]        # ultimate vectors only need to be called wit
 
 ### Docstrings
 
-```@docs
+```@docs; canonical=false
 MortalityTables.survival
 ```
 
-```@docs
+```@docs; canonical=false
 MortalityTables.decrement
 ```
 ## Life Expectancy
@@ -229,7 +229,7 @@ Calculate curtate or complete life expectancy.
 
 ### Docstrings
 
-```@docs
+```@docs; canonical=false
 MortalityTables.life_expectancy
 ```
 
@@ -247,7 +247,7 @@ The three assumptions are:
 - `Balducci()` which assumes a decreasing force of mortality over the year. It seems [to
 be for making it easier](https://www.soa.org/globalassets/assets/library/research/actuarial-research-clearing-house/1978-89/1988/arch-1/arch88v17.pdf) to calculate successive months by hand rather than any theoretical basis.
 
-```@docs
+```@docs; canonical=false
 MortalityTables.DeathDistribution
 MortalityTables.Balducci
 MortalityTables.Uniform

diff --git a/docs/src/design.md b/docs/src/design.md
@@ -7,16 +7,19 @@ There are two types of MortalityTable subtypes for SOA data: `SelectUltimateTabl
 A table with both select and ultimate rates:
 
 ```@example
+using MortalityTables
 MortalityTables.table("2001 VBT Residual Standard Select and Ultimate - Male Nonsmoker, ANB")
 ```
 
 A table with just ultimate rates:
+
 ```@example
+using MortalityTables
 MortalityTables.table("1941 CSO Basic Table, ANB")
 ```
 
 ## Motivation for the current design
-x
+
 ### Encourage data-driven design
 
 Probably best explained with an example. In the following example, we calculate the ultimate survivorship for every age in the `cso` table from above. The table itself gives us the right range of ages to do this with. No need to assume a 100 or 121 omega age and handle edge cases when working with tables that don't line up to the usual expectations.
@@ -46,6 +49,7 @@ survival(MortalityTables.Makeham(),25,50) # 25 to 50 year old survival
 When you display a table, you get to see related metadata, which can be lost if simply parsing into a matrix or dataframe:
 
 ```@example
+using MortalityTables
 MortalityTables.table("2001 VBT Residual Standard Select and Ultimate - Male Nonsmoker, ANB")
 ```
 

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -197,7 +197,7 @@ aus_life_table_female[0]  # returns the attained age 0 rate of 0.10139
 
 ### From CSV
 
-If you have a CSV file that is from [mort.SOA.org](mort.SOA.org), or follows the same structure, then you can load and parse the table into a `MortalityTable` like so:
+If you have a CSV file that is from [mort.SOA.org](https://mort.SOA.org), or follows the same structure, then you can load and parse the table into a `MortalityTable` like so:
 
 ```julia
 using CSV