👌 IMPROVE: Making in-page TOC title configurable #299
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
choldgraf
reviewed
Mar 7, 2021
sphinx_book_theme/__init__.py
Outdated
| out = f""" | ||
| <div class="tocsection onthispage pt-5 pb-3"> | ||
| <i class="fas fa-list"></i> { context["translate"]('Contents') } | ||
| <i class="fas fa-list"></i> { context["theme_toc_title"] } |
There was a problem hiding this comment.
Could we keep the translate bit? I think that this would attempt to auto-translate the title for versions of the book that are in different languages. Is that right? Is there any downside to keeping the translate?
There was a problem hiding this comment.
You are right, translate is a function with signature <function get_translation.<locals>.gettext. So, it should auto-translate.
There was a problem hiding this comment.
pradyunsg
reviewed
Mar 8, 2021
Co-authored-by: Pradyun Gedam <3275593+pradyunsg@users.noreply.github.com>
|
thanks very much! |
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 PR makes in-page TOC title configurable with the introduction of the following key:
The default value of the title has been kept as
Contents.It will throw an error if the title is set to empty (I reckon a title is always necessary?)
@choldgraf is there any exception handling format we need to follow for this repo. or the way I have handled it is ok?
fixes #297