Upgrade Documenter, and add make target to fix doctests #26515
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
make -C doc doctest-fix
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.
This upgrades Documenter to
v0.15.0(https://github.com/JuliaDocs/Documenter.jl/releases/tag/v0.15.0).In particular this release includes JuliaDocs/Documenter.jl#656 which adds a
fixflag tomakedocsthat will update all the outdated doctests. This is something I am pretty excited about -- you would be surprised how fast our docs get outdated! I added a new make target for running the fix indoc/Makefile, so running:should now update all the doctests to the new output.
This is something we should do before every new release, to make sure docs are up to date. This is also very useful when doing other changes to the code -- instead of manually updating all the docstrings, it should in theory be enough to run
make -C doc doctest-fixto update to the new output, see e.g. #20288