add base framework for library reference

[nominatim.git] / docs / mkdocs.yml

diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index 22a9f9fe795aaf259e2d6bb4121d73ac62ae5876..fd1995ab55b75402ffc7c3a3dc9afead7e9a498c 100644 (file)
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -3,7 +3,7 @@ theme: readthedocs
 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

-pages:
+nav:

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


@@ -28,26 +28,33 @@ pages:
         - 'Overview': 'customize/Overview.md'
         - 'Import Styles': 'customize/Import-Styles.md'
         - 'Configuration Settings': 'customize/Settings.md'
         - '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'
         - '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'
         - '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':
+        - 'Introduction': 'library/Introduction.md'
+        - 'Getting Started': 'library/Getting-Started.md'
+        - 'Reference': 'library/Reference.md'

     - 'Developers Guide':
         - 'Architecture Overview' : 'develop/overview.md'
         - 'Database Layout' : 'develop/Database-Layout.md'
     - 'Developers Guide':
         - 'Architecture Overview' : 'develop/overview.md'
         - 'Database Layout' : 'develop/Database-Layout.md'

+        - 'Indexing' : 'develop/Indexing.md'

         - 'Tokenizers' : 'develop/Tokenizers.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':
         - 'Setup for Development' : 'develop/Development-Environment.md'
         - 'Testing' : 'develop/Testing.md'
         - 'External Data Sources': 'develop/data-sources.md'
     - 'Appendix':

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

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

 markdown_extensions:
     - codehilite
     - admonition
 markdown_extensions:
     - codehilite
     - admonition

+    - pymdownx.superfences

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


@@ -57,6 +64,7 @@ plugins:
     - mkdocstrings:
         handlers:
           python:
     - mkdocstrings:
         handlers:
           python:

-            rendering:
-              show_source: false
-              show_signature_annotations: false
+            paths: ["${PROJECT_SOURCE_DIR}"]
+            options:
+              show_source: False
+              show_bases: False