1 site_name: Nominatim Documentation
3 docs_dir: ${CMAKE_CURRENT_BINARY_DIR}
4 site_url: https://nominatim.org
5 repo_url: https://github.com/openstreetmap/Nominatim
7 - 'Introduction' : 'index.md'
9 - 'Overview': 'api/Overview.md'
10 - 'Search': 'api/Search.md'
11 - 'Reverse': 'api/Reverse.md'
12 - 'Address Lookup': 'api/Lookup.md'
13 - 'Details' : 'api/Details.md'
14 - 'Status' : 'api/Status.md'
15 - 'Place Output Formats': 'api/Output.md'
17 - 'Administration Guide':
18 - 'Basic Installation': 'admin/Installation.md'
19 - 'Import' : 'admin/Import.md'
20 - 'Update' : 'admin/Update.md'
21 - 'Deploy' : 'admin/Deployment.md'
22 - 'Nominatim UI' : 'admin/Setup-Nominatim-UI.md'
23 - 'Advanced Installations' : 'admin/Advanced-Installations.md'
24 - 'Maintenance' : 'admin/Maintenance.md'
25 - 'Migration from older Versions' : 'admin/Migration.md'
26 - 'Troubleshooting' : 'admin/Faq.md'
27 - 'Customization Guide':
28 - 'Overview': 'customize/Overview.md'
29 - 'Import Styles': 'customize/Import-Styles.md'
30 - 'Configuration Settings': 'customize/Settings.md'
31 - 'Per-Country Data': 'customize/Country-Settings.md'
32 - 'Place Ranking' : 'customize/Ranking.md'
33 - 'Importance' : 'customize/Importance.md'
34 - 'Tokenizers' : 'customize/Tokenizers.md'
35 - 'Special Phrases': 'customize/Special-Phrases.md'
36 - 'External data: US housenumbers from TIGER': 'customize/Tiger.md'
37 - 'External data: Postcodes': 'customize/Postcodes.md'
39 - 'Getting Started': 'library/Getting-Started.md'
40 - 'Nominatim API class': 'library/NominatimAPI.md'
41 - 'Configuration': 'library/Configuration.md'
42 - 'Input Parameter Types': 'library/Input-Parameter-Types.md'
43 - 'Result Handling': 'library/Result-Handling.md'
44 - 'Low-level DB Access': 'library/Low-Level-DB-Access.md'
46 - 'Architecture Overview' : 'develop/overview.md'
47 - 'Database Layout' : 'develop/Database-Layout.md'
48 - 'Indexing' : 'develop/Indexing.md'
49 - 'Tokenizers' : 'develop/Tokenizers.md'
50 - 'Custom modules for ICU tokenizer': 'develop/ICU-Tokenizer-Modules.md'
51 - 'Setup for Development' : 'develop/Development-Environment.md'
52 - 'Testing' : 'develop/Testing.md'
53 - 'External Data Sources': 'develop/data-sources.md'
55 - 'Installation on Ubuntu 20' : 'appendix/Install-on-Ubuntu-20.md'
56 - 'Installation on Ubuntu 22' : 'appendix/Install-on-Ubuntu-22.md'
60 - pymdownx.superfences
65 extra_css: [extra.css, styles.css]
71 paths: ["${PROJECT_SOURCE_DIR}"]