Use PEP 604 unions in docs

Billyzhang1229 · Billyzhang1229 · commit 27d6a1911400 · 2026-02-04T22:08:06.000Z
diff --git a/docs/conf.py b/docs/conf.py
@@ -60,6 +60,9 @@
     *[p.stem for p in (HERE / "extensions").glob("*.py")],
 ]
 
+# Prefer PEP 604 union syntax (X | Y) to avoid unresolved typing.Union references.
+always_use_bars_union = True
+
 # Enable math notation in mystnb
 myst_enable_extensions = [
     "amsmath",
@@ -112,7 +115,6 @@ def filter(self, record: pylogging.LogRecord) -> bool:
 
 nitpick_ignore = [
     ("py:class", "sgkit.display.GenotypeDisplay"),
-    ("py:data", "typing.Union"),
 ]
 
 

Original file line number	Diff line number	Diff line change
`@@ -60,6 +60,9 @@`
`60`	`60`	`[p.stem for p in (HERE / "extensions").glob(".py")],`
`61`	`61`	`]`
`62`	`62`
	`63`	`+# Prefer PEP 604 union syntax (X \| Y) to avoid unresolved typing.Union references.`
	`64`	`+always_use_bars_union = True`
	`65`	`+`
`63`	`66`	`# Enable math notation in mystnb`
`64`	`67`	`myst_enable_extensions = [`
`65`	`68`	`"amsmath",`
`@@ -112,7 +115,6 @@ def filter(self, record: pylogging.LogRecord) -> bool:`
`112`	`115`
`113`	`116`	`nitpick_ignore = [`
`114`	`117`	`("py:class", "sgkit.display.GenotypeDisplay"),`
`115`		`- ("py:data", "typing.Union"),`
`116`	`118`	`]`
`117`	`119`
`118`	`120`