adapt installation instruction for different frontends

[nominatim.git] / docs / mkdocs.yml

diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index 69926f4efc1fcf4ac09bc0aea92dbd2229df61b1..fb8ad07205dbb520eb440d58dd1ecbecbaf77568 100644 (file)
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -1,9 +1,13 @@
 site_name: Nominatim Documentation
 site_name: Nominatim Documentation

-theme: readthedocs
+theme:
+  name: material
+  features:
+    - navigation.tabs
+copyright: Copyright © 2023 Nominatim developer community

 docs_dir: ${CMAKE_CURRENT_BINARY_DIR}
 docs_dir: ${CMAKE_CURRENT_BINARY_DIR}

-site_url: http://nominatim.org
+site_url: https://nominatim.org

 repo_url: https://github.com/openstreetmap/Nominatim
 repo_url: https://github.com/openstreetmap/Nominatim

-pages:
+nav:

     - 'Introduction' : 'index.md'
     - 'API Reference':
         - 'Overview': 'api/Overview.md'
     - 'Introduction' : 'index.md'
     - 'API Reference':
         - 'Overview': 'api/Overview.md'


@@ -11,27 +15,66 @@ pages:
         - 'Reverse': 'api/Reverse.md'
         - 'Address Lookup': 'api/Lookup.md'
         - 'Details' : 'api/Details.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'
         - 'Place Output Formats': 'api/Output.md'
         - 'FAQ': 'api/Faq.md'
     - 'Administration Guide':
         - 'Basic Installation': 'admin/Installation.md'

-        - 'Importing and Updating' : 'admin/Import-and-Update.md'
+        - 'Import' : 'admin/Import.md'
+        - 'Update' : 'admin/Update.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'

         - 'Migration from older Versions' : 'admin/Migration.md'
         - 'Troubleshooting' : 'admin/Faq.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'
+    - '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':
     - 'Developers Guide':

-        - 'Overview' : 'develop/overview.md'
-        - 'Place Ranking' : 'develop/Ranking.md'
-    - 'External Data Sources':
-        - 'Overview' : 'data-sources/overview.md'
-        - 'US Census (Tiger)': 'data-sources/US-Tiger.md'
-        - 'Country Grid': 'data-sources/Country-Grid.md'
+        - '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':
     - 'Appendix':

-        - 'Installation on CentOS 7' : 'appendix/Install-on-Centos-7.md'
-        - 'Installation on Ubuntu 16' : 'appendix/Install-on-Ubuntu-16.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:
 markdown_extensions:

-    - codehilite:
-        use_pygments: False
+    - codehilite
+    - admonition
+    - pymdownx.superfences
+    - pymdownx.tabbed:
+        alternate_style: true
+    - def_list

     - toc:
         permalink: 
     - toc:
         permalink: 

-extra_css: [extra.css]
+extra_css: [extra.css, styles.css]
+plugins:
+    - search
+    - mkdocstrings:
+        handlers:
+          python:
+            paths: ["${PROJECT_SOURCE_DIR}"]
+            options:
+              show_source: False
+              show_bases: False