This repository has been archived by the owner on Oct 23, 2022. It is now read-only.
Fix relative paths in new emitter docs #131
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
alfredclwong
changed the title
BrianGun
approved these changes
Apr 21, 2021
Enabling this option probably did more harm than good. It made locally built docs easier to navigate, but it meant that the local and remote doc builds differed in directory structure, which is confusing and difficult to work with.
We need to go back one time because the html paths are relative to
docs/build/emitters_new/index.html rather than
docs/build/emitters_new.html, which is what the prettyurl doc build
would have you believe.
Fixes #129
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
I think that the confusion came from me enabling the
prettyurlsargument inmakedocsindocs/make.jl.Enabling this option probably did more harm than good. It made locally built docs easier to navigate, but it meant that the local and remote doc builds differed in directory structure, which is confusing and difficult to work with.
We need to go back one time because the html paths are relative to
docs/build/emitters_new/index.htmlrather thandocs/build/emitters_new.html, which is what theprettyurldoc build would have you believe. Confusingly, julia code is executed from docs/build, which means thatVis.saveshouldn't go back in its relative path!Will upgrade this from a draft PR once the preview confirms the fix.Fixed!