Adds testing and hopefully a final fix for the empty toctree issue #375
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 adds some more hacky fixes to our layout to avoid singlehtml builders. Instead of trying to guess if this is working, I added testing!
ericholscher
approved these changes
Mar 6, 2017
There was a problem hiding this comment.
Looks good overall. Hopefully snide will be moving the theme over to @rtfd tonight, and then we can setup Travis to confirm.
sphinx_rtd_theme/layout.html
Outdated
| @@ -129,7 +129,7 @@ | |||
| The singlehtml builder doesn't handle this toctree call when the | |||
| toctree is empty. Skip building this for now. | |||
| #} | |||
| {% if builder != 'singlehtml' %} | |||
| {% if builder not in ['singlehtml', 'readthedocssinglehtml', 'readthedocssinglehtmllocalmedia'] %} | |||
There was a problem hiding this comment.
Any reason not to do if 'singlehtml' in builder?
There was a problem hiding this comment.
I debated it. It's probably a cleaner implementation, so 👍
| '<a class="reference internal" href="index.html#document-bar">bar</a>' | ||
| '</li>\n' | ||
| '</ul>' | ||
| ) |
There was a problem hiding this comment.
This seems brittle, I wonder if we could just look for the class names? local-toc vs. toctree-wrapper?
There was a problem hiding this comment.
It shouldn't be all that brittle, but I do think it's important to test the full thing. Otherwise, we won't be testing if the toctrees have anything in them, which is the more important part.
|
Ha, just happened :) |
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 adds some more hacky fixes to our layout to avoid singlehtml builders.
Instead of trying to guess if this is working, I added testing!