]> git.openstreetmap.org Git - nominatim.git/commitdiff
more adaptions for mkdocstrings griffin plugin
authorSarah Hoffmann <lonvia@denofr.de>
Sat, 19 Aug 2023 07:34:31 +0000 (09:34 +0200)
committerSarah Hoffmann <lonvia@denofr.de>
Fri, 25 Aug 2023 19:40:20 +0000 (21:40 +0200)
docs/customize/Tokenizers.md
docs/develop/ICU-Tokenizer-Modules.md
docs/develop/Tokenizers.md
docs/extra.css

index 4a9d77bd6c1633344c7cc5e394f401047b7daf72..2c7b687834ba7cd53308833d6179586813ba29aa 100644 (file)
@@ -176,72 +176,64 @@ The following is a list of sanitizers that are shipped with Nominatim.
 ##### split-name-list
 
 ::: nominatim.tokenizer.sanitizers.split_name_list
-    selection:
-        members: False
     options:
+        members: False
         heading_level: 6
         docstring_section_style: spacy
 
 ##### strip-brace-terms
 
 ::: nominatim.tokenizer.sanitizers.strip_brace_terms
-    selection:
-        members: False
     options:
+        members: False
         heading_level: 6
         docstring_section_style: spacy
 
 ##### tag-analyzer-by-language
 
 ::: nominatim.tokenizer.sanitizers.tag_analyzer_by_language
-    selection:
-        members: False
     options:
+        members: False
         heading_level: 6
         docstring_section_style: spacy
 
 ##### clean-housenumbers
 
 ::: nominatim.tokenizer.sanitizers.clean_housenumbers
-    selection:
-        members: False
     options:
+        members: False
         heading_level: 6
         docstring_section_style: spacy
 
 ##### clean-postcodes
 
 ::: nominatim.tokenizer.sanitizers.clean_postcodes
-    selection:
-        members: False
     options:
+        members: False
         heading_level: 6
         docstring_section_style: spacy
 
 ##### clean-tiger-tags
 
 ::: nominatim.tokenizer.sanitizers.clean_tiger_tags
-    selection:
-        members: False
     options:
+        members: False
         heading_level: 6
         docstring_section_style: spacy
 
 #### delete-tags
 
 ::: nominatim.tokenizer.sanitizers.delete_tags
-    selection:
-        members: False
     options:
+        members: False
         heading_level: 6
         docstring_section_style: spacy
 
 #### tag-japanese
 
 ::: nominatim.tokenizer.sanitizers.tag_japanese
-    selection:
-        members: False
     options:
+        members: False
         heading_level: 6
         docstring_section_style: spacy
 
index f1853006f00400ed772126a10a4901e1550bd0eb..63b1c3c1db5833f1f53225252f424d426e0941b8 100644 (file)
@@ -54,7 +54,7 @@ the function.
 
 ::: nominatim.tokenizer.sanitizers.config.SanitizerConfig
     options:
-        heading_level: 3
+        heading_level: 6
 
 ### The main filter function of the sanitizer
 
@@ -75,14 +75,14 @@ adding extra attributes) or completely replace the list with a different one.
 
 ::: nominatim.data.place_info.PlaceInfo
     options:
-        heading_level: 3
+        heading_level: 6
 
 
 #### PlaceName - extended naming information
 
 ::: nominatim.data.place_name.PlaceName
     options:
-        heading_level: 3
+        heading_level: 6
 
 
 ### Example: Filter for US street prefixes
@@ -141,12 +141,12 @@ They can be found in the directory
 
 ::: nominatim.tokenizer.token_analysis.base.AnalysisModule
     options:
-        heading_level: 3
+        heading_level: 6
 
 
 ::: nominatim.tokenizer.token_analysis.base.Analyzer
     options:
-        heading_level: 3
+        heading_level: 6
 
 ### Example: Creating acronym variants for long names
 
index c82071b62aa82dd3d8246307472528bbbc441174..050371771c27eb21ffa7158efbc261e8ae35154d 100644 (file)
@@ -135,13 +135,13 @@ and implement the abstract functions defined there.
 
 ::: nominatim.tokenizer.base.AbstractTokenizer
     options:
-        heading_level: 3
+        heading_level: 6
 
 ### Python Analyzer Class
 
 ::: nominatim.tokenizer.base.AbstractAnalyzer
     options:
-        heading_level: 3
+        heading_level: 6
 
 ### PL/pgSQL Functions
 
index 3aecf2ef750e2eae298708eb7e2b8b20cdc9d8ac..f2cc55eefd1bf3877a6036958e4a3014a3dc4663 100644 (file)
@@ -2,6 +2,10 @@
     display: none!important
 }
 
+.wy-nav-content {
+    max-width: 900px!important
+}
+
 table {
     margin-bottom: 12pt
 }
@@ -16,9 +20,12 @@ th {
 
 .doc-object h6 {
     margin-bottom: 0.8em;
-    font-size: 120%;
+    font-size: 140%;
 }
 
 .doc-object {
     margin-bottom: 1.3em;
 }
+
+.doc-children .doc-contents {
+    margin-left: 3em;