mirror of
https://github.com/osm-search/Nominatim.git
synced 2024-09-11 19:17:17 +03:00
82 lines
3.3 KiB
YAML
82 lines
3.3 KiB
YAML
site_name: Nominatim Manual
|
|
theme:
|
|
name: material
|
|
features:
|
|
- navigation.tabs
|
|
copyright: Copyright © Nominatim developer community
|
|
docs_dir: ${CMAKE_CURRENT_BINARY_DIR}
|
|
site_url: https://nominatim.org
|
|
repo_url: https://github.com/openstreetmap/Nominatim
|
|
nav:
|
|
- 'Introduction' : 'index.md'
|
|
- 'API Reference':
|
|
- 'Overview': 'api/Overview.md'
|
|
- 'Search': 'api/Search.md'
|
|
- 'Reverse': 'api/Reverse.md'
|
|
- 'Address Lookup': 'api/Lookup.md'
|
|
- 'Details' : 'api/Details.md'
|
|
- 'Status' : 'api/Status.md'
|
|
- 'Place Output Formats': 'api/Output.md'
|
|
- 'FAQ': 'api/Faq.md'
|
|
- 'Administration Guide':
|
|
- 'Basic Installation': 'admin/Installation.md'
|
|
- 'Import' : 'admin/Import.md'
|
|
- 'Update' : 'admin/Update.md'
|
|
- 'Deploy (Python frontend)' : 'admin/Deployment-Python.md'
|
|
- 'Deploy (PHP frontend)' : 'admin/Deployment-PHP.md'
|
|
- 'Nominatim UI' : 'admin/Setup-Nominatim-UI.md'
|
|
- 'Advanced Installations' : 'admin/Advanced-Installations.md'
|
|
- 'Maintenance' : 'admin/Maintenance.md'
|
|
- 'Migration from older Versions' : 'admin/Migration.md'
|
|
- 'Troubleshooting' : 'admin/Faq.md'
|
|
- 'Customization Guide':
|
|
- 'Overview': 'customize/Overview.md'
|
|
- 'Import Styles': 'customize/Import-Styles.md'
|
|
- 'Configuration Settings': 'customize/Settings.md'
|
|
- 'Per-Country Data': 'customize/Country-Settings.md'
|
|
- 'Place Ranking' : 'customize/Ranking.md'
|
|
- 'Importance' : 'customize/Importance.md'
|
|
- 'Tokenizers' : 'customize/Tokenizers.md'
|
|
- 'Special Phrases': 'customize/Special-Phrases.md'
|
|
- 'External data: US housenumbers from TIGER': 'customize/Tiger.md'
|
|
- 'External data: Postcodes': 'customize/Postcodes.md'
|
|
- 'Conversion to SQLite': 'customize/SQLite.md'
|
|
- 'Library Guide':
|
|
- 'Getting Started': 'library/Getting-Started.md'
|
|
- 'Nominatim API class': 'library/NominatimAPI.md'
|
|
- 'Configuration': 'library/Configuration.md'
|
|
- 'Input Parameter Types': 'library/Input-Parameter-Types.md'
|
|
- 'Result Handling': 'library/Result-Handling.md'
|
|
- 'Low-level DB Access': 'library/Low-Level-DB-Access.md'
|
|
- 'Developers Guide':
|
|
- 'Architecture Overview' : 'develop/overview.md'
|
|
- 'Database Layout' : 'develop/Database-Layout.md'
|
|
- 'Indexing' : 'develop/Indexing.md'
|
|
- 'Tokenizers' : 'develop/Tokenizers.md'
|
|
- 'Custom modules for ICU tokenizer': 'develop/ICU-Tokenizer-Modules.md'
|
|
- 'Setup for Development' : 'develop/Development-Environment.md'
|
|
- 'Testing' : 'develop/Testing.md'
|
|
- 'External Data Sources': 'develop/data-sources.md'
|
|
- 'Appendix':
|
|
- 'Installation on Ubuntu 22' : 'appendix/Install-on-Ubuntu-22.md'
|
|
- 'Installation on Ubuntu 24' : 'appendix/Install-on-Ubuntu-24.md'
|
|
markdown_extensions:
|
|
- codehilite
|
|
- admonition
|
|
- pymdownx.superfences
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- def_list
|
|
- toc:
|
|
permalink:
|
|
extra_css: [extra.css, styles.css]
|
|
plugins:
|
|
- search
|
|
- mkdocstrings:
|
|
handlers:
|
|
python:
|
|
paths: ["${PROJECT_SOURCE_DIR}/src"]
|
|
options:
|
|
show_source: False
|
|
show_bases: False
|