Admin FAQ entry for UnicodeEncodeError

[nominatim.git] / docs / mkdocs.yml

diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index c3af00bd8d03c54c046933124f7c8f744e6e5bb7..fa65a11b97874ccbe001e8edc20b41846cccf840 100644 (file)
--- 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
 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'
         - 'Basic Installation': 'admin/Installation.md'
         - 'Import' : 'admin/Import.md'
         - 'Update' : 'admin/Update.md'

-        - 'Deploy' : 'admin/Deployment.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'
         - 'Nominatim UI'  : 'admin/Setup-Nominatim-UI.md'
         - 'Advanced Installations' : 'admin/Advanced-Installations.md'
         - 'Maintenance' : 'admin/Maintenance.md'


@@ -35,6 +40,7 @@ nav:
         - 'Special Phrases': 'customize/Special-Phrases.md'
         - 'External data: US housenumbers from TIGER': 'customize/Tiger.md'
         - 'External data: Postcodes': 'customize/Postcodes.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'
     - 'Library Guide':
         - 'Getting Started': 'library/Getting-Started.md'
         - 'Nominatim API class': 'library/NominatimAPI.md'


@@ -52,12 +58,14 @@ nav:
         - 'Testing' : 'develop/Testing.md'
         - 'External Data Sources': 'develop/data-sources.md'
     - 'Appendix':
         - 'Testing' : 'develop/Testing.md'
         - 'External Data Sources': 'develop/data-sources.md'
     - 'Appendix':

-        - 'Installation on Ubuntu 20' : 'appendix/Install-on-Ubuntu-20.md'

         - 'Installation on Ubuntu 22' : 'appendix/Install-on-Ubuntu-22.md'
         - 'Installation on Ubuntu 22' : 'appendix/Install-on-Ubuntu-22.md'

+        - 'Installation on Ubuntu 24' : 'appendix/Install-on-Ubuntu-24.md'

 markdown_extensions:
     - codehilite
     - admonition
     - pymdownx.superfences
 markdown_extensions:
     - codehilite
     - admonition
     - pymdownx.superfences

+    - pymdownx.tabbed:
+        alternate_style: true

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


@@ -67,7 +75,7 @@ plugins:
     - mkdocstrings:
         handlers:
           python:
     - mkdocstrings:
         handlers:
           python:

-            paths: ["${PROJECT_SOURCE_DIR}"]
+            paths: ["${PROJECT_SOURCE_DIR}/src"]

             options:
               show_source: False
               show_bases: False
             options:
               show_source: False
               show_bases: False