Setup our own translator without override the existing one #42
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
07e659f to
8563b2a
Compare
Instead of fully override the translator set by the user (or another Sphinx extension), we create a new class dynamically by inheriting the translator that's defined and adding our own Mixin class with our custom behavior. This way, we are compatible with other extensions nicely. As a example, I tested this with pydata-sphinx-theme (https://github.com/pandas-dev/pydata-sphinx-theme) that defines a custom translator. Besides, this new approach is compatible with people using HTML5 translator by default since we are not forcing HTML4 when inheriting our own custom class anymore.
8563b2a to
15671c8
Compare
…itos/setup-translators
Suggested by Eric
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.
Instead of fully override the translator set by the user (or another
Sphinx extension), we create a new class dynamically by inheriting the
translator that's defined and adding our own Mixin class with our
custom behavior.
This way, we are compatible with other extensions nicely.
As a example, I tested this with
pydata-sphinx-theme (https://github.com/pandas-dev/pydata-sphinx-theme)
that defines a custom translator.
Besides, this new approach is compatible with people using HTML5
translator by default since we are not forcing HTML4 when inheriting
our own custom class anymore.
This is related to #14