X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/b1903f0fbf1e41c594be9b20f00b8a621dfe7552..899a04ad264c45197ec7509b164c934a05392f30:/docs/mkdocs.yml diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 48fe1d0d..3301356d 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,5 +1,9 @@ -site_name: Nominatim Documentation -theme: readthedocs +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 @@ -18,7 +22,8 @@ nav: - 'Basic Installation': 'admin/Installation.md' - 'Import' : 'admin/Import.md' - 'Update' : 'admin/Update.md' - - 'Deploy' : 'admin/Deployment.md' + - 'Deploy (PHP frontend)' : 'admin/Deployment-PHP.md' + - 'Deploy (Python frontend)' : 'admin/Deployment-Python.md' - 'Nominatim UI' : 'admin/Setup-Nominatim-UI.md' - 'Advanced Installations' : 'admin/Advanced-Installations.md' - 'Maintenance' : 'admin/Maintenance.md' @@ -30,26 +35,36 @@ nav: - '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' + - '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 CentOS 8' : 'appendix/Install-on-Centos-8.md' - - 'Installation on Ubuntu 18' : 'appendix/Install-on-Ubuntu-18.md' - 'Installation on Ubuntu 20' : 'appendix/Install-on-Ubuntu-20.md' - 'Installation on Ubuntu 22' : 'appendix/Install-on-Ubuntu-22.md' markdown_extensions: - codehilite - admonition + - pymdownx.superfences + - pymdownx.tabbed: + alternate_style: true - def_list - toc: permalink:  @@ -59,6 +74,7 @@ plugins: - mkdocstrings: handlers: python: - rendering: - show_source: false - show_signature_annotations: false + paths: ["${PROJECT_SOURCE_DIR}"] + options: + show_source: False + show_bases: False