Fix documentation deployment #247
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was no compatibility set for the Documenter dependency in `docs/Project.toml`, so a breaking change made in Documenter 1.0 broke documentation deployment for this package. In particular, the `strict` keyword argument in `makedocs` was replaced with `warnonly`. To fix it, we can declare explicit compatibility with Documenter 1.0 and switch to using `warnonly=true` rather than `strict=false`. As part of this, I've also added standard entries to `.gitignore`, two of which are relevant to documentation: the automatically generated `docs/build/` directory and `Manifest.toml`.
Codecov Report
@@ Coverage Diff @@
## master #247 +/- ##
=======================================
Coverage 90.34% 90.34%
=======================================
Files 4 4
Lines 259 259
=======================================
Hits 234 234
Misses 25 25 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was no compatibility set for the Documenter dependency in
docs/Project.toml, so a breaking change made in Documenter 1.0 broke documentation deployment for this package. In particular, thestrictkeyword argument inmakedocswas replaced withwarnonly. To fix it, we can declare explicit compatibility with Documenter 1.0 and switch to usingwarnonly=truerather thanstrict=false.As part of this, I've also added standard entries to
.gitignore, two of which are relevant to documentation: the automatically generateddocs/build/directory andManifest.toml.