Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Upgrade Documenter to version 1.0 #24

Merged
merged 7 commits into from
Jul 10, 2024
Merged

Upgrade Documenter to version 1.0 #24

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
de39212
Upgrade to Documenter 1.0
pnavaro Jul 5, 2024
c802889
Update Project.toml
pnavaro Jul 5, 2024
966cfb9
Update docs/Project.toml
pnavaro Jul 6, 2024
4326c7b
Update test/Project.toml
pnavaro Jul 6, 2024
29fe73e
Merge branch 'main' into upgrade_documenter
pnavaro Jul 10, 2024
6f99a36
Update test/Project.toml
devmotion Jul 10, 2024
9fce70f
Merge branch 'main' into upgrade_documenter
devmotion Jul 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
PythonOT = "3c485715-4278-42b2-9b5f-8f00e43c12ef"

[compat]
Documenter = "0.27"
Documenter = "1"
PythonOT = "0.1"
julia = "1"
3 changes: 1 addition & 2 deletions docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,14 @@ DocMeta.setdocmeta!(PythonOT, :DocTestSetup, :(using PythonOT); recursive=true)
makedocs(;
modules=[PythonOT, PythonOT.Smooth],
authors="David Widmann",
repo="https://github.com/JuliaOptimalTransport/PythonOT.jl/blob/{commit}{path}#{line}",
sitename="PythonOT.jl",
format=Documenter.HTML(;
prettyurls=get(ENV, "CI", "false") == "true",
canonical="https://juliaoptimaltransport.github.io/PythonOT.jl",
repolink="https://github.com/JuliaOptimalTransport/PythonOT.jl/blob/{commit}{path}#{line}",
assets=String[],
),
pages=["Home" => "index.md", "api.md"],
strict=true,
checkdocs=:exports,
doctestfilters=[
r"{([a-zA-Z0-9]+,\s?)+[a-zA-Z0-9]+}",
Expand Down
2 changes: 1 addition & 1 deletion test/Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

[compat]
Documenter = "0.27"
Documenter = "1"
Copy link
Member

Choose a reason for hiding this comment

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

It seems Julia 1.0 is not compatible with Documenter >= 1.0. It would be fine to drop support for Julia 1.0 at this point but I think we can keep it for now since it should not require any additional maintenance: For the doctests, docs/make.jl and the Documenter 1.0 specific settings are irrelevant, so keeping support for Documenter 0.27 in the tests seems safe.

Suggested change
Documenter = "1"
Documenter = "0.27, 1"

julia = "1"
Loading