Skip to content

Commit

Permalink
CompatHelper: bump compat for Documenter to 1 for package docs, (keep…
Browse files Browse the repository at this point in the history
… existing compat) (#1778)

* CompatHelper: bump compat for Documenter to 1 for package docs, (keep existing compat)

* Update Project.toml

* Set `warnonly` kwarg

---------

Co-authored-by: CompatHelper Julia <[email protected]>
Co-authored-by: Viral B. Shah <[email protected]>
Co-authored-by: David Widmann <[email protected]>
  • Loading branch information
4 people authored Jan 17, 2025
1 parent 3b981a0 commit 1e6801d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
GR = "28b8d3ca-fb5f-59d9-8090-bfdbd6d07a71"

[compat]
Documenter = "0.26, 0.27"
Documenter = "1"
GR = "0.72.1, 0.73"
7 changes: 4 additions & 3 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
using Documenter, Distributions
import Random: AbstractRNG, rand!

makedocs(
makedocs(;
sitename = "Distributions.jl",
modules = [Distributions],
format = Documenter.HTML(; prettyurls = get(ENV, "CI", nothing) == "true"),
Expand All @@ -23,11 +23,12 @@ makedocs(
"fit.md",
"extends.md",
"density_interface.md",
]
],
warnonly = true,
)

deploydocs(;
repo = "github.com/JuliaStats/Distributions.jl.git",
versions = ["stable" => "v^", "v#.#", "dev" => "master"],
push_preview=true,
push_preview = true,
)

2 comments on commit 1e6801d

@devmotion
Copy link
Member

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/123196

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

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.25.117 -m "<description of version>" 1e6801da6678164b13330cc1f16e670768d27330
git push origin v0.25.117

Please sign in to comment.