Match RTD directory URLs to TOC index.html #153
Merged
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.
The ReadTheDocs site is supposed to highlight the current page in the table of contents, but this does not work if the URL is a directory. ReadTheDocs will automatically resolve the page to the
index.htmlfile in the directory, but the script for highlighting the page in the TOC will fail to find the page because the directory URL does not match the URL in the TOC, which ends inindex.html.Example, the page
...external/core-module-reference/does not match...external/core-module-reference/index.htmlin the TOC.This updates the matching logic to compare the URLs again after appending
index.html, if there is not already a match.See an example of this working at https://shader-slanggithubio-aidanfnv-wip.readthedocs.io/en/fix-directory-url-toc-highlight/external/core-module-reference/