Update Documenter to 1.3 #364
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
This enables the automatic writing of an `objects.inv` inventory file.
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 enables the automatic writing of an
objects.invinventory file.See https://discourse.julialang.org/t/ann-documenter-v1-3-0-inventories/111139
Technically, this PR doesn't do anything, since the next time the CI for building the documentation runs, it should be using the latest Documenter 1.3 anyway (based on the existing compat bound of "1"). The real motivation behind this PR is to trigger that CI to run when it is merged, so that https://docs.sciml.ai/RecursiveArrayTools/dev/objects.inv will exist, and I can use DocumenterInterLinks to link from my project into the documentation for
RecursiveArrayTools. If you make a bugfix release based on this PR, the stable version inventory would exist at https://docs.sciml.ai/RecursiveArrayTools/stable/objects.inv, which would be even nicer.You can also ignore this PR and manually run the CI to update the documentation for
devand/or the stable release, see the instructions at the very bottom of the Discourse post.