Skip to content

Commit

Permalink
Update docs to use Documenter v1 (#12)
Browse files Browse the repository at this point in the history
* Updates for Documenterv1

* Increment patch number
  • Loading branch information
sethaxen authored Sep 25, 2023
1 parent 78e8abf commit 570b688
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "ArviZExampleData"
uuid = "2f96bb34-afd9-46ae-bcd0-9b2d4372fe3c"
authors = ["Seth Axen <[email protected]> and contributors"]
version = "0.1.5"
version = "0.1.6"

[deps]
Artifacts = "56f22d72-fd6d-98f1-02f0-08ddc0907c33"
Expand Down
3 changes: 3 additions & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
[deps]
ArviZExampleData = "2f96bb34-afd9-46ae-bcd0-9b2d4372fe3c"
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"

[compat]
Documenter = "1"
3 changes: 2 additions & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ DocMeta.setdocmeta!(
makedocs(;
modules=[ArviZExampleData],
authors="Seth Axen <[email protected]> and contributors",
repo="https://github.com/arviz-devs/ArviZExampleData.jl/blob/{commit}{path}#{line}",
repo=Remotes.GitHub("arviz-dev", "ArviZExampleData.jl"),
sitename="ArviZExampleData.jl",
format=Documenter.HTML(;
prettyurls=get(ENV, "CI", "false") == "true",
Expand All @@ -22,6 +22,7 @@ makedocs(;
"API" => "api.md",
"For developers" => "for_developers.md",
],
warnonly=:missing_docs,
)

deploydocs(; repo="github.com/arviz-devs/ArviZExampleData.jl", devbranch="main")

2 comments on commit 570b688

@sethaxen
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/92198

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.6 -m "<description of version>" 570b6883b4398de7655cbf2afc554ef96691bf9c
git push origin v0.1.6

Please sign in to comment.