]> 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         - 'Place Output Formats': 'api/Output.md'
15         - 'FAQ': 'api/Faq.md'
16     - 'Administration Guide':
17         - 'Basic Installation': 'admin/Installation.md'
18         - 'Importing and Updating' : 'admin/Import-and-Update.md'
19         - 'Advanced Installations' : 'admin/Advanced-Installations.md'
20         - 'Migration from older Versions' : 'admin/Migration.md'
21         - 'Troubleshooting' : 'admin/Faq.md'
22     - 'Developers Guide':
23         - 'Overview' : 'develop/overview.md'
24         - 'OSM Data Import' : 'develop/Import.md'
25         - 'Place Ranking' : 'develop/Ranking.md'
26         - 'Postcodes' : 'develop/Postcodes.md'
27         - 'Documentation' : 'develop/Documentation.md'
28     - 'External Data Sources':
29         - 'Overview' : 'data-sources/overview.md'
30         - 'US Census (Tiger)': 'data-sources/US-Tiger.md'
31         - 'GB Postcodes': 'data-sources/GB-Postcodes.md'
32         - 'Country Grid': 'data-sources/Country-Grid.md'
33         - 'Wikipedia & Wikidata': 'data-sources/Wikipedia-Wikidata.md'
34     - 'Appendix':
35         - 'Installation on CentOS 7' : 'appendix/Install-on-Centos-7.md'
36         - 'Installation on Ubuntu 16' : 'appendix/Install-on-Ubuntu-16.md'
37         - 'Installation on Ubuntu 18' : 'appendix/Install-on-Ubuntu-18.md'
38 markdown_extensions:
39     - codehilite
40     - admonition
41     - toc:
42         permalink: 
43 extra_css: [extra.css, styles.css]