feat: add source_language config and lang attr for untranslated text#14429
Open
hesam-oxe wants to merge 1 commit into
Open
feat: add source_language config and lang attr for untranslated text#14429hesam-oxe wants to merge 1 commit into
hesam-oxe wants to merge 1 commit into
Conversation
Added source_language config option. Set lang attribute on untranslated nodes for WCAG 3.1.2 compliance. Closes sphinx-doc#13841
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
1 participant
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.
Added
source_languageconfig option andlangattribute onuntranslated nodes for WCAG SC 3.1.2 compliance.
Problem
When working with mixed-language web content, HTML elements should use
the
langattribute to define their language if it differs from the<html>page language. Without this, documentation produced with Sphinxfails WCAG SC 3.1.2 Language of Parts.
Changes
config.py— Addedsource_languageconfig option (default:"en")transforms/i18n.py— Setnode['lang']tosource_languageonuntranslated nodes in
AddTranslationClasseswriters/html5.py— Overridestarttag()inHTML5Translatortorespect node
langattributeResult
Before:
After:
References
Closes #13841