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

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

Merged
merged 4 commits into from
Nov 11, 2023
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b65d102
CompatHelper: bump compat for Documenter to 1 for package docs, (keep…
Nov 11, 2023
89744dc
just use v1 of Documenter.jl
ranocha Nov 11, 2023
3a74fef
no strict keyword anymore
ranocha Nov 11, 2023
65284fc
ignore size threshold for API reference file
ranocha Nov 11, 2023
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,5 +3,5 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
MPI = "da04e1cc-30fd-572f-bb4f-1f8673147195"

[compat]
Documenter = "0.26, 0.27"
Documenter = "1"
MPI = "0.20"
4 changes: 2 additions & 2 deletions docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,8 @@ makedocs(
# Explicitly add favicon as asset
# assets = ["assets/favicon.ico"],
# Set canonical URL to GitHub pages URL
canonical = "https://trixi-framework.github.io/P4est.jl/stable"
canonical = "https://trixi-framework.github.io/P4est.jl/stable",
size_threshold_ignore = ["reference.md"]
),
# Explicitly specify documentation structure
pages = [
Expand All @@ -105,7 +106,6 @@ makedocs(
"Contributing" => "contributing.md",
"License" => "license.md"
],
strict = true, # `true` lets Documenter CI fail when doctests fail
checkdocs = :exports, # complain only about non-included docstrings for exported names
)

Expand Down