Add RTL support #13338
Open
Add RTL support #13338
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
- Add is_rtl theme option for right-to-left text direction - Implement automatic layout mirroring for RTL languages - Keep code blocks in LTR direction
CHANGES.rst
Outdated
| @@ -111,6 +111,10 @@ Features added | |||
| * #13326: Remove hardcoding from handling :class:`~sphinx.addnodes.productionlist` | |||
| nodes in all writers, to improve flexibility. | |||
| Patch by Adam Turner. | |||
| * #10385: Add RTL (right-to-left) support for all Sphinx themes via ``is_rtl`` | |||
There was a problem hiding this comment.
Suggested change
| * #10385: Add RTL (right-to-left) support for all Sphinx themes via ``is_rtl`` | |
| * #10385: Add RTL (right-to-left) support for all Sphinx themes via the ``is_rtl`` |
CHANGES.rst
Outdated
| * #10385: Add RTL (right-to-left) support for all Sphinx themes via ``is_rtl`` | ||
| theme option. Includes automatic layout mirroring, and bidirectional text | ||
| support. | ||
| Patch by Revisto. |
There was a problem hiding this comment.
Suggested change
| Patch by Revisto. | |
| Patch by Alireza Shabani. |
Usually we use names (see above entries) rather than github @s but its up to you.
| - Keep code blocks in LTR direction | ||
|
|
||
| Defaults to ``False``. | ||
|
|
There was a problem hiding this comment.
A version added block would be a nice addition
| div.admonition { | ||
| border-right: 0.2em solid black !important; | ||
| border-left: none !important; | ||
| padding: 2px 7px 1px 7px !important; |
There was a problem hiding this comment.
Suggested change
| padding: 2px 7px 1px 7px !important; |
This is redundant? It is already defined, you are overriding the exact same thing
I presume there are more cases of this
- Add "the" before "is_rtl" - Fix line wrapping in CHANGES.rst entry
- Change "Revisto" to "Alireza Shabani"
|
Hi @StanFromIreland, thank you so much for your review. I fixed the grammar issue, and changed my name to |
AA-Turner
requested changes
Feb 15, 2025
|
Hi, I tried to remove the duplications, hope it helps. |
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.
Purpose
Add RTL (right-to-left) support for all Sphinx themes to improve accessibility for RTL languages like Farsi (Persian), Arabic, and Hebrew.
Key features:
is_rtltheme option for enabling RTL layoutImplementation Details
is_rtl(defaults tofalse)Questions
References
I'm eager to improve this implementation and would love to continue working on it. Open to suggestions and ready to make any necessary changes to align with Sphinx's standards.