X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/dfa74daf52f9421e0bcacebaeceff149339eb534..b8a73192128b162ea32bf2f622875a543a39d955:/docs/mkdocs.yml?ds=sidebyside diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index d647dd87..eb624d8b 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,18 +1,66 @@ site_name: Nominatim Documentation theme: readthedocs docs_dir: ${CMAKE_CURRENT_BINARY_DIR} -site_url: http://nominatim.org +site_url: https://nominatim.org repo_url: https://github.com/openstreetmap/Nominatim -pages: +nav: - 'Introduction' : 'index.md' + - 'API Reference': + - 'Overview': 'api/Overview.md' + - 'Search': 'api/Search.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' - - 'Importing and Updating' : 'admin/Import-and-Update.md' + - 'Import' : 'admin/Import.md' + - 'Update' : 'admin/Update.md' + - 'Deploy' : 'admin/Deployment.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' + - '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' + - '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 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: - - codehilite: - use_pygments: False + - codehilite + - admonition + - pymdownx.superfences + - def_list + - toc: + permalink:  +extra_css: [extra.css, styles.css] +plugins: + - search + - mkdocstrings: + handlers: + python-legacy: + rendering: + show_source: false + show_signature_annotations: false