]> git.openstreetmap.org Git - nominatim.git/blob - docs/mkdocs.yml
Merge remote-tracking branch 'upstream/master'
[nominatim.git] / docs / mkdocs.yml
1 site_name: Nominatim Documentation
2 theme: readthedocs
3 docs_dir: ${CMAKE_CURRENT_BINARY_DIR}
4 site_url: https://nominatim.org
5 repo_url: https://github.com/openstreetmap/Nominatim
6 pages:
7     - 'Introduction' : 'index.md'
8     - 'API Reference':
9         - 'Overview': 'api/Overview.md'
10         - 'Search': 'api/Search.md'
11         - 'Reverse': 'api/Reverse.md'
12         - 'Address Lookup': 'api/Lookup.md'
13         - 'Details' : 'api/Details.md'
14         - 'Status' : 'api/Status.md'
15         - 'Place Output Formats': 'api/Output.md'
16         - 'FAQ': 'api/Faq.md'
17     - 'Administration Guide':
18         - 'Basic Installation': 'admin/Installation.md'
19         - 'Import' : 'admin/Import.md'
20         - 'Update' : 'admin/Update.md'
21         - 'Deploy' : 'admin/Deployment.md'
22         - 'Nominatim UI'  : 'admin/Setup-Nominatim-UI.md'
23         - 'Advanced Installations' : 'admin/Advanced-Installations.md'
24         - 'Maintenance' : 'admin/Maintenance.md'
25         - 'Migration from older Versions' : 'admin/Migration.md'
26         - 'Troubleshooting' : 'admin/Faq.md'
27     - 'Customization Guide':
28         - 'Overview': 'customize/Overview.md'
29         - 'Import Styles': 'customize/Import-Styles.md'
30         - 'Configuration Settings': 'customize/Settings.md'
31         - 'Place Ranking' : 'customize/Ranking.md'
32         - 'Tokenizers' : 'customize/Tokenizers.md'
33         - 'Special Phrases': 'customize/Special-Phrases.md'
34         - 'External data: US housenumbers from TIGER': 'customize/Tiger.md'
35         - 'External data: Postcodes': 'customize/Postcodes.md'
36     - 'Developers Guide':
37         - 'Architecture Overview' : 'develop/overview.md'
38         - 'Database Layout' : 'develop/Database-Layout.md'
39         - 'Indexing' : 'develop/Indexing.md'
40         - 'Tokenizers' : 'develop/Tokenizers.md'
41         - 'Setup for Development' : 'develop/Development-Environment.md'
42         - 'Testing' : 'develop/Testing.md'
43         - 'External Data Sources': 'develop/data-sources.md'
44     - 'Appendix':
45         - 'Installation on CentOS 7' : 'appendix/Install-on-Centos-7.md'
46         - 'Installation on CentOS 8' : 'appendix/Install-on-Centos-8.md'
47         - 'Installation on Ubuntu 18' : 'appendix/Install-on-Ubuntu-18.md'
48         - 'Installation on Ubuntu 20' : 'appendix/Install-on-Ubuntu-20.md'
49 markdown_extensions:
50     - codehilite
51     - admonition
52     - def_list
53     - toc:
54         permalink: 
55 extra_css: [extra.css, styles.css]
56 plugins:
57     - search
58     - mkdocstrings:
59         handlers:
60           python:
61             rendering:
62               show_source: false
63               show_signature_annotations: false