From: Sarah Hoffmann Date: Sat, 19 Aug 2023 07:34:31 +0000 (+0200) Subject: more adaptions for mkdocstrings griffin plugin X-Git-Tag: v4.3.0~13^2~14 X-Git-Url: https://git.openstreetmap.org/nominatim.git/commitdiff_plain/e672de036e950c21a5870ebb0967e0df90267cb8 more adaptions for mkdocstrings griffin plugin --- diff --git a/docs/customize/Tokenizers.md b/docs/customize/Tokenizers.md index 4a9d77bd..2c7b6878 100644 --- a/docs/customize/Tokenizers.md +++ b/docs/customize/Tokenizers.md @@ -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 diff --git a/docs/develop/ICU-Tokenizer-Modules.md b/docs/develop/ICU-Tokenizer-Modules.md index f1853006..63b1c3c1 100644 --- a/docs/develop/ICU-Tokenizer-Modules.md +++ b/docs/develop/ICU-Tokenizer-Modules.md @@ -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 diff --git a/docs/develop/Tokenizers.md b/docs/develop/Tokenizers.md index c82071b6..05037177 100644 --- a/docs/develop/Tokenizers.md +++ b/docs/develop/Tokenizers.md @@ -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 diff --git a/docs/extra.css b/docs/extra.css index 3aecf2ef..f2cc55ee 100644 --- a/docs/extra.css +++ b/docs/extra.css @@ -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;