update to modern mkdocstrings python handler

[nominatim.git] / docs / develop / ICU-Tokenizer-Modules.md

diff --git a/docs/develop/ICU-Tokenizer-Modules.md b/docs/develop/ICU-Tokenizer-Modules.md
index 2cf30a5699f7863db7db1f7eb04f7fa2ae3bf1b5..f1853006f00400ed772126a10a4901e1550bd0eb 100644 (file)
--- a/docs/develop/ICU-Tokenizer-Modules.md
+++ b/docs/develop/ICU-Tokenizer-Modules.md
@@ -53,21 +53,18 @@ the function.
 ### Sanitizer configuration
 
 ::: nominatim.tokenizer.sanitizers.config.SanitizerConfig
 ### Sanitizer configuration
 
 ::: nominatim.tokenizer.sanitizers.config.SanitizerConfig

-    rendering:
-        show_source: no
-        heading_level: 6
+    options:
+        heading_level: 3

 
 ### The main filter function of the sanitizer
 
 The filter function receives a single object of type `ProcessInfo`
 which has with three members:
 
 
 ### The main filter function of the sanitizer
 
 The filter function receives a single object of type `ProcessInfo`
 which has with three members:
 

- * `place`: read-only information about the place being processed.
+ * `place: PlaceInfo`: read-only information about the place being processed.

    See PlaceInfo below.
    See PlaceInfo below.

- * `names`: The current list of names for the place. Each name is a
-   PlaceName object.
- * `address`: The current list of address names for the place. Each name
-   is a PlaceName object.
+ * `names: List[PlaceName]`: The current list of names for the place.
+ * `address: List[PlaceName]`: The current list of address names for the place.

 
 While the `place` member is provided for information only, the `names` and
 `address` lists are meant to be manipulated by the sanitizer. It may add and
 
 While the `place` member is provided for information only, the `names` and
 `address` lists are meant to be manipulated by the sanitizer. It may add and


@@ -77,17 +74,15 @@ adding extra attributes) or completely replace the list with a different one.
 #### PlaceInfo - information about the place
 
 ::: nominatim.data.place_info.PlaceInfo
 #### PlaceInfo - information about the place
 
 ::: nominatim.data.place_info.PlaceInfo

-    rendering:
-        show_source: no
-        heading_level: 6
+    options:
+        heading_level: 3

 
 
 #### PlaceName - extended naming information
 
 ::: nominatim.data.place_name.PlaceName
 
 
 #### PlaceName - extended naming information
 
 ::: nominatim.data.place_name.PlaceName

-    rendering:
-        show_source: no
-        heading_level: 6
+    options:
+        heading_level: 3

 
 
 ### Example: Filter for US street prefixes
 
 
 ### Example: Filter for US street prefixes


@@ -145,15 +140,13 @@ They can be found in the directory
 ## Custom token analysis module
 
 ::: nominatim.tokenizer.token_analysis.base.AnalysisModule
 ## Custom token analysis module
 
 ::: nominatim.tokenizer.token_analysis.base.AnalysisModule

-    rendering:
-        show_source: no
-        heading_level: 6
+    options:
+        heading_level: 3

 
 
 ::: nominatim.tokenizer.token_analysis.base.Analyzer
 
 
 ::: nominatim.tokenizer.token_analysis.base.Analyzer

-    rendering:
-        show_source: no
-        heading_level: 6
+    options:
+        heading_level: 3

 
 ### Example: Creating acronym variants for long names
 
 
 ### Example: Creating acronym variants for long names