Use langcodes to generate html lang attribute, update changelog

object-Object · object-Object · commit 585a3702c234 · 2026-02-01T15:28:25.000-05:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and [Pydantic's HISTORY.md](https://github.com/pydantic/pydantic/blob/main/HISTORY.md), and this project *mostly* adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## `1!0.1.0a36`
+
+### Changed
+
+* The `lang` attribute in `index.html` is now generated using [langcodes](https://pypi.org/project/langcodes/) instead of always defaulting to `en`.
+
+### Fixed
+
+* Fixed the language selector defaulting to "English (United States)" if the translation is missing.
+
 ## `1!0.1.0a35`
 
 ### Fixed
diff --git a/pyproject.toml b/pyproject.toml
@@ -43,6 +43,7 @@ dependencies = [
     "hatch~=1.9",
     "importlib_resources~=6.0",
     "Jinja2~=3.1",
+    "langcodes~=3.5",
     "moderngl[headless]~=5.10",
     "moderngl-window~=2.4",
     "more_itertools~=10.1",
diff --git a/src/hexdoc/_templates/index.html.jinja b/src/hexdoc/_templates/index.html.jinja
@@ -1,7 +1,7 @@
 {% import "macros/formatting.html.jinja" as fmt with context %}
 
 <!DOCTYPE html>
-<html lang="en">
+<html lang="{{ lang_html }}">
   <head>
     {% block head %}
       <title>{{ _("hexdoc."~props.modid~".title") }}</title>
diff --git a/src/hexdoc/jinja/render.py b/src/hexdoc/jinja/render.py
@@ -6,6 +6,7 @@
 from pathlib import Path
 from typing import Any, Mapping, Sequence
 
+import langcodes
 from _hexdoc_favicons import Favicons
 from jinja2 import (
     BaseLoader,
@@ -200,6 +201,7 @@ def render_book(
         "version": version,
         "lang": lang,
         "lang_name": lang_name,
+        "lang_html": langcodes.standardize_tag(lang),
         "is_bleeding_edge": version.startswith("latest"),
         "favicons_html": favicons_html,
         "favicons_formats": favicons_formats,
diff --git a/test/integration/__snapshots__/test_copier/test_index[vlatestmainen_usindex.html].raw b/test/integration/__snapshots__/test_copier/test_index[vlatestmainen_usindex.html].raw
@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html lang="en">
+<html lang="en-US">
   <head>
       <title>Mod Book</title>
       <meta charset="utf-8" />
diff --git a/test/integration/__snapshots__/test_main_1.19/test_files[vlatestmainen_usindex.html].raw b/test/integration/__snapshots__/test_main_1.19/test_files[vlatestmainen_usindex.html].raw
@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html lang="en">
+<html lang="en-US">
   <head>
       <title>Hex Book</title>
       <meta charset="utf-8" />
diff --git a/test/integration/__snapshots__/test_main_main/test_files[vlatestmainen_usindex.html].raw b/test/integration/__snapshots__/test_main_main/test_files[vlatestmainen_usindex.html].raw
@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html lang="en">
+<html lang="en-US">
   <head>
       <title>Hex Book</title>
       <meta charset="utf-8" />
