Move to Documenter 1.0 (and some miscellaneous fixes) #266
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
|
Once the documentation build has completed, you can preview any updated documentation at this URL: https://fluxml.ai/Metalhead.jl/previews/PR266/ |
|
Buildkite errors seem to be mirroring those discussed in #264? So probably not related |
ToucheSir
approved these changes
Dec 26, 2023
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.
Tidied up our Documenter workflow a little and also migrated to Documenter 1.0 (which has some more features and has the added benefit of looking nicer!).
One thing that may have been confusing here is the
utilities.jlfile. It's been listed as part of theLayersmodule on the docs but hasn't been in that folder? So that's been fixed. The file is still sourced in Metalhead proper though.Some other miscellaneous fixes:
Flux.Convwith a doc reference, but whatever we were doing before wasn't working. Removed the link for now.using Downloadsto stop a deprecation warning from popping up every time we test.This is probably a start for some PRs for the docs, hopefully I can find time and improve them further soon.