Fixed the generation of TOCs #102
Merged
+8
−2
Conversation
This file contains hidden or 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
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.
In some private tests we saw that a short TOC was displayed in two columns (as if it was a long TOC) whereas a slightly longer TOC was displayed in a single column.
The reason is that we were counting all TOC elements, instead of only the visible elements.
Please note that this PR is almost, but not entirely, correct. I had to hardcode the number of visible TOC levels at
2(by far, the most common value in Symfony-related docs) but this should instead be obtained dynamically via themaxdepthTOC tree option in the RST contents.