Skip to content

Commit

Permalink
update for Documenter 1.0 (#77)
Browse files Browse the repository at this point in the history
* update for Documenter 1.0

* organize API page
  • Loading branch information
alecloudenback authored Oct 28, 2023
1 parent 939a465 commit da17127
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 20 deletions.
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,5 @@ docs/site/
Manifest.toml

# other
~*.xlsx
*.DS_Store
*.DS_Store
settings.json
3 changes: 3 additions & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
LifeContingencies = "c8f0d631-89cd-4a1f-93d0-7542c3692561"
11 changes: 5 additions & 6 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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 <[email protected]> and contributors",
authors="Alec Loudenback <[email protected]> and contributors"
)

deploydocs(;
repo="github.com/JuliaActuary/LifeContingencies.jl",
repo="github.com/JuliaActuary/LifeContingencies.jl"
)
22 changes: 10 additions & 12 deletions docs/src/api.md
Original file line number Diff line number Diff line change
@@ -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
<script>
window.goatcounter = {
path: function(p) { return location.host + p }
}
</script>
<script data-goatcounter="https://juliaactuary.goatcounter.com/count"
async src="//gc.zgo.at/count.js"></script>
```

Please [open an issue](https://github.com/JuliaActuary/LifeContingencies.jl/issues) if you encounter any issues or confusion with the package.

0 comments on commit da17127

Please sign in to comment.