mkdocs.yml

   1 site_name: Nominatim Manual
   2 theme:
   3   font: false
   4   name: material
   5   features:
   6     - navigation.tabs
   7     - toc.integrate
   8   plugins:
   9     - privacy
  10 copyright: Copyright &copy; Nominatim developer community
  11 docs_dir: docs
  12 site_url: https://nominatim.org
  13 repo_url: https://github.com/openstreetmap/Nominatim
  14 nav:
  15     - 'Introduction' : 'index.md'
  16     - 'API Reference':
  17         - 'Overview': 'api/Overview.md'
  18         - 'Search': 'api/Search.md'
  19         - 'Reverse': 'api/Reverse.md'
  20         - 'Address Lookup': 'api/Lookup.md'
  21         - 'Details' : 'api/Details.md'
  22         - 'Status' : 'api/Status.md'
  23         - 'Place Output Formats': 'api/Output.md'
  24         - 'FAQ': 'api/Faq.md'
  25     - 'Administration Guide':
  26         - 'Basic Installation': 'admin/Installation.md'
  27         - 'Import' : 'admin/Import.md'
  28         - 'Update' : 'admin/Update.md'
  29         - 'Deploy (Python frontend)' : 'admin/Deployment-Python.md'
  30         - 'Deploy (PHP frontend)' : 'admin/Deployment-PHP.md'
  31         - 'Nominatim UI'  : 'admin/Setup-Nominatim-UI.md'
  32         - 'Advanced Installations' : 'admin/Advanced-Installations.md'
  33         - 'Maintenance' : 'admin/Maintenance.md'
  34         - 'Migration from older Versions' : 'admin/Migration.md'
  35         - 'Troubleshooting' : 'admin/Faq.md'
  36         - 'Installation on Ubuntu 22' : 'admin/Install-on-Ubuntu-22.md'
  37         - 'Installation on Ubuntu 24' : 'admin/Install-on-Ubuntu-24.md'
  38     - 'Customization Guide':
  39         - 'Overview': 'customize/Overview.md'
  40         - 'Import Styles': 'customize/Import-Styles.md'
  41         - 'Configuration Settings': 'customize/Settings.md'
  42         - 'API Result Formatting': 'customize/Result-Formatting.md'
  43         - 'Per-Country Data': 'customize/Country-Settings.md'
  44         - 'Place Ranking' : 'customize/Ranking.md'
  45         - 'Importance' : 'customize/Importance.md'
  46         - 'Tokenizers' : 'customize/Tokenizers.md'
  47         - 'Special Phrases': 'customize/Special-Phrases.md'
  48         - 'External data: US housenumbers from TIGER': 'customize/Tiger.md'
  49         - 'External data: Postcodes': 'customize/Postcodes.md'
  50         - 'Conversion to SQLite': 'customize/SQLite.md'
  51     - 'Library Guide':
  52         - 'Getting Started': 'library/Getting-Started.md'
  53         - 'Nominatim API class': 'library/NominatimAPI.md'
  54         - 'Configuration': 'library/Configuration.md'
  55         - 'Input Parameter Types': 'library/Input-Parameter-Types.md'
  56         - 'Result Handling': 'library/Result-Handling.md'
  57         - 'Low-level DB Access': 'library/Low-Level-DB-Access.md'
  58     - 'Developers Guide':
  59         - 'Architecture Overview' : 'develop/overview.md'
  60         - 'Database Layout' : 'develop/Database-Layout.md'
  61         - 'Indexing' : 'develop/Indexing.md'
  62         - 'Tokenizers' : 'develop/Tokenizers.md'
  63         - 'Custom modules for ICU tokenizer': 'develop/ICU-Tokenizer-Modules.md'
  64         - 'Setup for Development' : 'develop/Development-Environment.md'
  65         - 'Testing' : 'develop/Testing.md'
  66         - 'External Data Sources': 'develop/data-sources.md'
  67 markdown_extensions:
  68     - codehilite
  69     - admonition
  70     - pymdownx.superfences
  71     - pymdownx.tabbed:
  72         alternate_style: true
  73     - def_list
  74     - toc:
  75         toc_depth: 4
  76         permalink: 🔗
  77 extra_css: [extra.css, styles.css]
  78 exclude_docs: |
  79     mk_install_instructions.py
  80 site_dir: site-html
  81 plugins:
  82     - search
  83     - mkdocstrings:
  84         handlers:
  85           python:
  86             paths: ["src"]
  87             options:
  88               show_source: False
  89               show_bases: False
  90     - gen-files:
  91         scripts:
  92           - docs/mk_install_instructions.py