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.

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

Migrate to Documenter@1 #52

Merged
merged 3 commits into from
Mar 13, 2024
Merged

Migrate to Documenter@1 #52

merged 3 commits into from
Mar 13, 2024

Conversation

bauglir
Copy link
Owner

@bauglir bauglir commented Mar 13, 2024

Documenter@1 has been out for a while now and it is about time the package migrates to it to ensure it is compatible (which it is).

The new behavior of Documenter writing images to files, JuliaDocs/Documenter.jl#2143, also fixes a recent issue with Structurizr diagrams no longer being properly rendered due to character sequences they include.

image

bauglir added 2 commits March 13, 2024 11:10
…strict`

The `strict` keyword argument is no longer supported as of
`Documenter@1`[^1]. The `warnonly` keyword argument is its replacement.
When running in CI all errors should be critical, which is the default,
but when not they reported as warnings so they can be resolved locally
without failing the build to make it easier to make more extensive
changes to the documentation using `LiveServer` which would otherwise
error as well.

[^1]: https://github.com/JuliaDocs/Documenter.jl/blob/master/CHANGELOG.md#breaking
@bauglir bauglir self-assigned this Mar 13, 2024
Copy link

codecov bot commented Mar 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (bd31ea4) to head (dc42ed5).

Additional details and impacted files
@@              Coverage Diff              @@
##           development       #52   +/-   ##
=============================================
  Coverage       100.00%   100.00%           
=============================================
  Files                5         5           
  Lines              147       147           
=============================================
  Hits               147       147           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@bauglir bauglir force-pushed the migrate-to-documenter-v1 branch 2 times, most recently from 8d7d93c to 58f49bf Compare March 13, 2024 10:38
@bauglir bauglir force-pushed the migrate-to-documenter-v1 branch from 58f49bf to dc42ed5 Compare March 13, 2024 10:46
@bauglir bauglir enabled auto-merge March 13, 2024 10:53
@bauglir bauglir merged commit 4a95bc1 into development Mar 13, 2024
12 checks passed
@bauglir bauglir deleted the migrate-to-documenter-v1 branch March 13, 2024 10:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant