X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/86eeb4d2eddaa6c409f542169780f59dc31ffc1b..6533af6a914de8f9107f2ffb4e6b431287b21be5:/docs/mkdocs.yml diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 0f4ed655..fd1995ab 100644 --- 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 -pages: +nav: - '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' + - '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': + - 'Introduction': 'library/Introduction.md' + - 'Getting Started': 'library/Getting-Started.md' + - 'Reference': 'library/Reference.md' - 'Developers Guide': - - 'Setup for Development' : 'develop/Development-Environment.md' - 'Architecture Overview' : 'develop/overview.md' - - 'OSM Data Import' : 'develop/Import.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 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 22' : 'appendix/Install-on-Ubuntu-22.md' markdown_extensions: - codehilite - admonition + - pymdownx.superfences - def_list - toc: permalink:  @@ -57,6 +64,7 @@ plugins: - mkdocstrings: handlers: python: - rendering: - show_source: false - show_signature_annotations: false + paths: ["${PROJECT_SOURCE_DIR}"] + options: + show_source: False + show_bases: False