Omit entries w/o URLs and external links from TOC #309
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
When building next/previous page entries, we want to ignore entries that don't have a URL. Our previous code only ignored chapters (top-level TOC entries) that didn't have a URL but (sub)sections without URLs would still get processed. This commit leaves (sub)sections out when processing the TOC. We also ignore external links when processing the TOC since it's jarring to accidentally press the `<Left>` arrow key and go to a completely different website.
|
Hey @SamLau95 - this looks good to me, though I just restarted the CircleCI build now that their bug was fixed and it seems there's an error in the tests, wanna investigate? |
|
I figured out the reason this test was failing and fixed it! Merging if tests are happy |
|
Thanks for fixing! I'm on vacation with family now so I appreciate it. |
|
We can trade off vacations in that case, I just got back from one :-) |
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.
When building next/previous page entries, we want to ignore entries that
don't have a URL.
Our previous code only ignored chapters (top-level TOC entries) that
didn't have a URL but (sub)sections without URLs would still get
processed. This commit leaves (sub)sections out when processing the TOC.
We also ignore external links when processing the TOC since it's jarring
to accidentally press the
<Left>arrow key and go to a completelydifferent website.