Abbreviate type aliases when reference by sphinx

TomHall2020 · TomHall2020 · commit 0cfaa495667d · 2024-03-12T22:48:48.000Z
diff --git a/docs/conf.py b/docs/conf.py
@@ -48,6 +48,6 @@
 autodoc_member_order = "bysource"
 napoleon_preprocess_types = True
 napoleon_type_aliases = {
-    "FaceSpec": "archeryutils.targets.FaceSpec",
-    "ScoringSystem": "archeryutils.targets.ScoringSystem"
+    "FaceSpec": "~archeryutils.targets.FaceSpec",
+    "ScoringSystem": "~archeryutils.targets.ScoringSystem",
 }

Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,6 @@`
`48`	`48`	`autodoc_member_order = "bysource"`
`49`	`49`	`napoleon_preprocess_types = True`
`50`	`50`	`napoleon_type_aliases = {`
`51`		`- "FaceSpec": "archeryutils.targets.FaceSpec",`
`52`		`- "ScoringSystem": "archeryutils.targets.ScoringSystem"`
	`51`	`+ "FaceSpec": "~archeryutils.targets.FaceSpec",`
	`52`	`+ "ScoringSystem": "~archeryutils.targets.ScoringSystem",`
`53`	`53`	`}`