Nominatim/mkdocs.yml

site_name: Nominatim Manual
theme:
  name: material
  features:
    - navigation.tabs
copyright: Copyright &copy; Nominatim developer community
docs_dir: docs
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'
        - 'Installation on Ubuntu 22' : 'admin/Install-on-Ubuntu-22.md'
        - 'Installation on Ubuntu 24' : 'admin/Install-on-Ubuntu-24.md'
    - 'Customization Guide':
        - 'Overview': 'customize/Overview.md'
        - 'Import Styles': 'customize/Import-Styles.md'
        - 'Configuration Settings': 'customize/Settings.md'
        - 'API Result Formatting': 'customize/Result-Formatting.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'
markdown_extensions:
    - codehilite
    - admonition
    - pymdownx.superfences
    - pymdownx.tabbed:
        alternate_style: true
    - def_list
    - toc:
        permalink: 🔗
extra_css: [extra.css, styles.css]
exclude_docs: |
    mk_install_instructions.py
site_dir: site-html
plugins:
    - search
    - mkdocstrings:
        handlers:
          python:
            paths: ["src"]
            options:
              show_source: False
              show_bases: False
    - gen-files:
        scripts:
          - docs/mk_install_instructions.py
rename documentation to 'Nominatim Manual' 2023-08-28 11:59:26 +03:00			`site_name: Nominatim Manual`
switch to material theme Needed for tabbed code blocks. 2023-08-25 23:47:07 +03:00			`theme:`
			`name: material`
			`features:`
			`- navigation.tabs`
rename documentation to 'Nominatim Manual' 2023-08-28 11:59:26 +03:00			`copyright: Copyright © Nominatim developer community`
build vagrant instructions dynamically with mkdocs-gen-files 2024-08-07 17:28:44 +03:00			`docs_dir: docs`
fix docs typos 2020-04-26 16:00:28 +03:00			`site_url: https://nominatim.org`
use mkdocs for compiling the documentation Requires to shuffle around the documentation. make doc will now compile the documentation in the build directory. The markdowns created from the vagrant files are no longer versioned. 2018-01-15 01:43:15 +03:00			`repo_url: https://github.com/openstreetmap/Nominatim`
docs: replace deprecated pages option Fixes #2661. 2022-06-25 22:29:00 +03:00			`nav:`
use mkdocs for compiling the documentation Requires to shuffle around the documentation. make doc will now compile the documentation in the build directory. The markdowns created from the vagrant files are no longer versioned. 2018-01-15 01:43:15 +03:00			`- 'Introduction' : 'index.md'`
copied API endpoint documentation from wiki.osm.org to /docs 2018-03-19 19:10:22 +03:00			`- 'API Reference':`
clean up and format search documentation 2018-08-06 00:38:19 +03:00			`- 'Overview': 'api/Overview.md'`
copied API endpoint documentation from wiki.osm.org to /docs 2018-03-19 19:10:22 +03:00			`- 'Search': 'api/Search.md'`
			`- 'Reverse': 'api/Reverse.md'`
			`- 'Address Lookup': 'api/Lookup.md'`
fix links in details documentation Thanks to @JamesKingdom. 2018-08-23 21:30:07 +03:00			`- 'Details' : 'api/Details.md'`
documenation for /status endpoint 2020-05-04 18:06:06 +03:00			`- 'Status' : 'api/Status.md'`
add description of output of API 2018-08-11 15:17:41 +03:00			`- 'Place Output Formats': 'api/Output.md'`
add FAQ from nominatim.org 2018-08-11 15:47:36 +03:00			`- 'FAQ': 'api/Faq.md'`
use mkdocs for compiling the documentation Requires to shuffle around the documentation. make doc will now compile the documentation in the build directory. The markdowns created from the vagrant files are no longer versioned. 2018-01-15 01:43:15 +03:00			`- 'Administration Guide':`
			`- 'Basic Installation': 'admin/Installation.md'`
restructure developer's manual Add a section on setting up the development environment which now also includes the former chapter on recreating the documentation. Move the README from test/ into the manual as the new Testing chapter. 2020-09-17 10:54:46 +03:00			`- 'Import' : 'admin/Import.md'`
			`- 'Update' : 'admin/Update.md'`
add deployment documentation for Python frontend 2023-08-27 22:27:16 +03:00			`- 'Deploy (Python frontend)' : 'admin/Deployment-Python.md'`
update documentation to recommend Python frontend 2024-02-15 21:48:32 +03:00			`- 'Deploy (PHP frontend)' : 'admin/Deployment-PHP.md'`
add usage docs for nominatim-ui Includes migration guides for Apache and nginx. 2020-06-13 21:06:01 +03:00			`- 'Nominatim UI' : 'admin/Setup-Nominatim-UI.md'`
Added Advanced Installations documentation 2020-04-15 14:48:57 +03:00			`- 'Advanced Installations' : 'admin/Advanced-Installations.md'`
docs: add new maintenance section currently used for postcode updates, word count updates and deleted relations. 2021-10-27 21:59:45 +03:00			`- 'Maintenance' : 'admin/Maintenance.md'`
use mkdocs for compiling the documentation Requires to shuffle around the documentation. make doc will now compile the documentation in the build directory. The markdowns created from the vagrant files are no longer versioned. 2018-01-15 01:43:15 +03:00			`- 'Migration from older Versions' : 'admin/Migration.md'`
			`- 'Troubleshooting' : 'admin/Faq.md'`
build vagrant instructions dynamically with mkdocs-gen-files 2024-08-07 17:28:44 +03:00			`- 'Installation on Ubuntu 22' : 'admin/Install-on-Ubuntu-22.md'`
			`- 'Installation on Ubuntu 24' : 'admin/Install-on-Ubuntu-24.md'`
docs: make customization chapter a separate section 2021-10-12 22:25:13 +03:00			`- 'Customization Guide':`
			`- 'Overview': 'customize/Overview.md'`
docs: move import style description to customize section 2021-10-13 00:07:41 +03:00			`- 'Import Styles': 'customize/Import-Styles.md'`
docs: make customization chapter a separate section 2021-10-12 22:25:13 +03:00			`- 'Configuration Settings': 'customize/Settings.md'`
add documentation for custom formatters 2024-08-14 19:22:59 +03:00			`- 'API Result Formatting': 'customize/Result-Formatting.md'`
add documentation for postcode customization 2022-06-20 18:42:12 +03:00			`- 'Per-Country Data': 'customize/Country-Settings.md'`
docs: move place ranking into customization part 2021-10-14 11:10:54 +03:00			`- 'Place Ranking' : 'customize/Ranking.md'`
docs: add customization hints for secondary importance Removing the download links for now as the tile importance is still too experimental. 2022-09-29 15:55:46 +03:00			`- 'Importance' : 'customize/Importance.md'`
docs: make customization chapter a separate section 2021-10-12 22:25:13 +03:00			`- 'Tokenizers' : 'customize/Tokenizers.md'`
docs: move import style description to customize section 2021-10-13 00:07:41 +03:00			`- 'Special Phrases': 'customize/Special-Phrases.md'`
docs: make customization chapter a separate section 2021-10-12 22:25:13 +03:00			`- 'External data: US housenumbers from TIGER': 'customize/Tiger.md'`
			`- 'External data: Postcodes': 'customize/Postcodes.md'`
add minimal documentation for the SQLite usage 2023-12-09 18:30:31 +03:00			`- 'Conversion to SQLite': 'customize/SQLite.md'`
add base framework for library reference 2023-08-18 19:05:57 +03:00			`- 'Library Guide':`
			`- 'Getting Started': 'library/Getting-Started.md'`
restructure library documentation 2023-08-22 22:46:10 +03:00			`- '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'`
add develop section to documentation 2018-02-12 21:51:02 +03:00			`- 'Developers Guide':`
restructure developer's manual Add a section on setting up the development environment which now also includes the former chapter on recreating the documentation. Move the README from test/ into the manual as the new Testing chapter. 2020-09-17 10:54:46 +03:00			`- 'Architecture Overview' : 'develop/overview.md'`
docs: section about database layout Replaces the import description which basically was table layout only now. 2021-10-29 13:03:22 +03:00			`- 'Database Layout' : 'develop/Database-Layout.md'`
docs: add overview over indexing 2021-11-01 13:04:03 +03:00			`- 'Indexing' : 'develop/Indexing.md'`
define formal public Python interface for tokenizer This introduces an abstract class for the Tokenizer/Analyzer for documentation purposes. 2021-08-10 15:51:35 +03:00			`- 'Tokenizers' : 'develop/Tokenizers.md'`
add documentation for sanitizer interface Also switches mkdocstrings to 0.18 with the rather unfortunate consequence that now mkdocstrings-python-legacy is needed as well. 2022-07-28 23:00:29 +03:00			`- 'Custom modules for ICU tokenizer': 'develop/ICU-Tokenizer-Modules.md'`
docs: section about database layout Replaces the import description which basically was table layout only now. 2021-10-29 13:03:22 +03:00			`- 'Setup for Development' : 'develop/Development-Environment.md'`
restructure developer's manual Add a section on setting up the development environment which now also includes the former chapter on recreating the documentation. Move the README from test/ into the manual as the new Testing chapter. 2020-09-17 10:54:46 +03:00			`- 'Testing' : 'develop/Testing.md'`
docs: move external data sources into simple page 2020-07-05 12:13:28 +03:00			`- 'External Data Sources': 'develop/data-sources.md'`
improve syntax highlighting for vagrant scripts 2018-01-16 01:47:00 +03:00			`markdown_extensions:`
switch to pygments for mkdocs hilighting 2019-10-26 00:57:23 +03:00			`- codehilite`
docs: add a note that the faltnode file is needed for updates Fixes #1644. 2020-01-22 13:44:05 +03:00			`- admonition`
add documentation for flex style Includes minor adaptions to bring the code in line with the documentation. 2022-12-23 13:10:40 +03:00			`- pymdownx.superfences`
switch to material theme Needed for tabbed code blocks. 2023-08-25 23:47:07 +03:00			`- pymdownx.tabbed:`
			`alternate_style: true`
add extended documentation of settings 2021-10-14 15:36:09 +03:00			`- def_list`
cleanup documentation Remove level 3 (page title) from TOC and add permalinks. Also fix and update some minor stuff in the docs. 2018-08-24 00:12:10 +03:00			`- toc:`
fix permalink character 2024-08-29 23:23:52 +03:00			`permalink: 🔗`
switch to pygments for mkdocs hilighting 2019-10-26 00:57:23 +03:00			`extra_css: [extra.css, styles.css]`
build vagrant instructions dynamically with mkdocs-gen-files 2024-08-07 17:28:44 +03:00			`exclude_docs: \|`
			`mk_install_instructions.py`
move generated docs to site-html 2024-08-07 17:48:22 +03:00			`site_dir: site-html`
define formal public Python interface for tokenizer This introduces an abstract class for the Tokenizer/Analyzer for documentation purposes. 2021-08-10 15:51:35 +03:00			`plugins:`
			`- search`
			`- mkdocstrings:`
			`handlers:`
update to modern mkdocstrings python handler 2023-08-18 18:28:45 +03:00			`python:`
build vagrant instructions dynamically with mkdocs-gen-files 2024-08-07 17:28:44 +03:00			`paths: ["src"]`
update to modern mkdocstrings python handler 2023-08-18 18:28:45 +03:00			`options:`
			`show_source: False`
			`show_bases: False`
build vagrant instructions dynamically with mkdocs-gen-files 2024-08-07 17:28:44 +03:00			`- gen-files:`
			`scripts:`
			`- docs/mk_install_instructions.py`