mirror of
https://github.com/osm-search/Nominatim.git
synced 2026-03-07 02:24:08 +00:00
more adaptions for mkdocstrings griffin plugin
This commit is contained in:
@@ -176,72 +176,64 @@ The following is a list of sanitizers that are shipped with Nominatim.
|
|||||||
##### split-name-list
|
##### split-name-list
|
||||||
|
|
||||||
::: nominatim.tokenizer.sanitizers.split_name_list
|
::: nominatim.tokenizer.sanitizers.split_name_list
|
||||||
selection:
|
|
||||||
members: False
|
|
||||||
options:
|
options:
|
||||||
|
members: False
|
||||||
heading_level: 6
|
heading_level: 6
|
||||||
docstring_section_style: spacy
|
docstring_section_style: spacy
|
||||||
|
|
||||||
##### strip-brace-terms
|
##### strip-brace-terms
|
||||||
|
|
||||||
::: nominatim.tokenizer.sanitizers.strip_brace_terms
|
::: nominatim.tokenizer.sanitizers.strip_brace_terms
|
||||||
selection:
|
|
||||||
members: False
|
|
||||||
options:
|
options:
|
||||||
|
members: False
|
||||||
heading_level: 6
|
heading_level: 6
|
||||||
docstring_section_style: spacy
|
docstring_section_style: spacy
|
||||||
|
|
||||||
##### tag-analyzer-by-language
|
##### tag-analyzer-by-language
|
||||||
|
|
||||||
::: nominatim.tokenizer.sanitizers.tag_analyzer_by_language
|
::: nominatim.tokenizer.sanitizers.tag_analyzer_by_language
|
||||||
selection:
|
|
||||||
members: False
|
|
||||||
options:
|
options:
|
||||||
|
members: False
|
||||||
heading_level: 6
|
heading_level: 6
|
||||||
docstring_section_style: spacy
|
docstring_section_style: spacy
|
||||||
|
|
||||||
##### clean-housenumbers
|
##### clean-housenumbers
|
||||||
|
|
||||||
::: nominatim.tokenizer.sanitizers.clean_housenumbers
|
::: nominatim.tokenizer.sanitizers.clean_housenumbers
|
||||||
selection:
|
|
||||||
members: False
|
|
||||||
options:
|
options:
|
||||||
|
members: False
|
||||||
heading_level: 6
|
heading_level: 6
|
||||||
docstring_section_style: spacy
|
docstring_section_style: spacy
|
||||||
|
|
||||||
##### clean-postcodes
|
##### clean-postcodes
|
||||||
|
|
||||||
::: nominatim.tokenizer.sanitizers.clean_postcodes
|
::: nominatim.tokenizer.sanitizers.clean_postcodes
|
||||||
selection:
|
|
||||||
members: False
|
|
||||||
options:
|
options:
|
||||||
|
members: False
|
||||||
heading_level: 6
|
heading_level: 6
|
||||||
docstring_section_style: spacy
|
docstring_section_style: spacy
|
||||||
|
|
||||||
##### clean-tiger-tags
|
##### clean-tiger-tags
|
||||||
|
|
||||||
::: nominatim.tokenizer.sanitizers.clean_tiger_tags
|
::: nominatim.tokenizer.sanitizers.clean_tiger_tags
|
||||||
selection:
|
|
||||||
members: False
|
|
||||||
options:
|
options:
|
||||||
|
members: False
|
||||||
heading_level: 6
|
heading_level: 6
|
||||||
docstring_section_style: spacy
|
docstring_section_style: spacy
|
||||||
|
|
||||||
#### delete-tags
|
#### delete-tags
|
||||||
|
|
||||||
::: nominatim.tokenizer.sanitizers.delete_tags
|
::: nominatim.tokenizer.sanitizers.delete_tags
|
||||||
selection:
|
|
||||||
members: False
|
|
||||||
options:
|
options:
|
||||||
|
members: False
|
||||||
heading_level: 6
|
heading_level: 6
|
||||||
docstring_section_style: spacy
|
docstring_section_style: spacy
|
||||||
|
|
||||||
#### tag-japanese
|
#### tag-japanese
|
||||||
|
|
||||||
::: nominatim.tokenizer.sanitizers.tag_japanese
|
::: nominatim.tokenizer.sanitizers.tag_japanese
|
||||||
selection:
|
|
||||||
members: False
|
|
||||||
options:
|
options:
|
||||||
|
members: False
|
||||||
heading_level: 6
|
heading_level: 6
|
||||||
docstring_section_style: spacy
|
docstring_section_style: spacy
|
||||||
|
|
||||||
|
|||||||
@@ -54,7 +54,7 @@ the function.
|
|||||||
|
|
||||||
::: nominatim.tokenizer.sanitizers.config.SanitizerConfig
|
::: nominatim.tokenizer.sanitizers.config.SanitizerConfig
|
||||||
options:
|
options:
|
||||||
heading_level: 3
|
heading_level: 6
|
||||||
|
|
||||||
### The main filter function of the sanitizer
|
### 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
|
::: nominatim.data.place_info.PlaceInfo
|
||||||
options:
|
options:
|
||||||
heading_level: 3
|
heading_level: 6
|
||||||
|
|
||||||
|
|
||||||
#### PlaceName - extended naming information
|
#### PlaceName - extended naming information
|
||||||
|
|
||||||
::: nominatim.data.place_name.PlaceName
|
::: nominatim.data.place_name.PlaceName
|
||||||
options:
|
options:
|
||||||
heading_level: 3
|
heading_level: 6
|
||||||
|
|
||||||
|
|
||||||
### Example: Filter for US street prefixes
|
### Example: Filter for US street prefixes
|
||||||
@@ -141,12 +141,12 @@ They can be found in the directory
|
|||||||
|
|
||||||
::: nominatim.tokenizer.token_analysis.base.AnalysisModule
|
::: nominatim.tokenizer.token_analysis.base.AnalysisModule
|
||||||
options:
|
options:
|
||||||
heading_level: 3
|
heading_level: 6
|
||||||
|
|
||||||
|
|
||||||
::: nominatim.tokenizer.token_analysis.base.Analyzer
|
::: nominatim.tokenizer.token_analysis.base.Analyzer
|
||||||
options:
|
options:
|
||||||
heading_level: 3
|
heading_level: 6
|
||||||
|
|
||||||
### Example: Creating acronym variants for long names
|
### Example: Creating acronym variants for long names
|
||||||
|
|
||||||
|
|||||||
@@ -135,13 +135,13 @@ and implement the abstract functions defined there.
|
|||||||
|
|
||||||
::: nominatim.tokenizer.base.AbstractTokenizer
|
::: nominatim.tokenizer.base.AbstractTokenizer
|
||||||
options:
|
options:
|
||||||
heading_level: 3
|
heading_level: 6
|
||||||
|
|
||||||
### Python Analyzer Class
|
### Python Analyzer Class
|
||||||
|
|
||||||
::: nominatim.tokenizer.base.AbstractAnalyzer
|
::: nominatim.tokenizer.base.AbstractAnalyzer
|
||||||
options:
|
options:
|
||||||
heading_level: 3
|
heading_level: 6
|
||||||
|
|
||||||
### PL/pgSQL Functions
|
### PL/pgSQL Functions
|
||||||
|
|
||||||
|
|||||||
@@ -2,6 +2,10 @@
|
|||||||
display: none!important
|
display: none!important
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.wy-nav-content {
|
||||||
|
max-width: 900px!important
|
||||||
|
}
|
||||||
|
|
||||||
table {
|
table {
|
||||||
margin-bottom: 12pt
|
margin-bottom: 12pt
|
||||||
}
|
}
|
||||||
@@ -16,9 +20,12 @@ th {
|
|||||||
|
|
||||||
.doc-object h6 {
|
.doc-object h6 {
|
||||||
margin-bottom: 0.8em;
|
margin-bottom: 0.8em;
|
||||||
font-size: 120%;
|
font-size: 140%;
|
||||||
}
|
}
|
||||||
|
|
||||||
.doc-object {
|
.doc-object {
|
||||||
margin-bottom: 1.3em;
|
margin-bottom: 1.3em;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.doc-children .doc-contents {
|
||||||
|
margin-left: 3em;
|
||||||
|
|||||||
Reference in New Issue
Block a user