Nominatim/docs/mkdocs.yml

site_name: Nominatim Documentation
theme: readthedocs
docs_dir: ${CMAKE_CURRENT_BINARY_DIR}
site_url: https://nominatim.org
repo_url: https://github.com/openstreetmap/Nominatim
pages:
    - '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'
        - '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'
        - 'Migration from older Versions' : 'admin/Migration.md'
        - 'Troubleshooting' : 'admin/Faq.md'
    - 'Developers Guide':
        - 'Setup for Development' : 'develop/Development-Environment.md'
        - 'Architecture Overview' : 'develop/overview.md'
        - 'OSM Data Import' : 'develop/Import.md'
        - 'Place Ranking' : 'develop/Ranking.md'
        - 'Postcodes' : 'develop/Postcodes.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'
markdown_extensions:
    - codehilite
    - admonition
    - toc:
        permalink: 
extra_css: [extra.css, styles.css]
use mkdocs for compiling the documentation Requires to shuffle around the documentation. make doc will now compile the documentation in the build directory. The markdowns created from the vagrant files are no longer versioned. 2018-01-15 01:43:15 +03:00			`site_name: Nominatim Documentation`
			`theme: readthedocs`
			`docs_dir: ${CMAKE_CURRENT_BINARY_DIR}`
fix docs typos 2020-04-26 16:00:28 +03:00			`site_url: https://nominatim.org`
use mkdocs for compiling the documentation Requires to shuffle around the documentation. make doc will now compile the documentation in the build directory. The markdowns created from the vagrant files are no longer versioned. 2018-01-15 01:43:15 +03:00			`repo_url: https://github.com/openstreetmap/Nominatim`
			`pages:`
			`- 'Introduction' : 'index.md'`
copied API endpoint documentation from wiki.osm.org to /docs 2018-03-19 19:10:22 +03:00			`- 'API Reference':`
clean up and format search documentation 2018-08-06 00:38:19 +03:00			`- 'Overview': 'api/Overview.md'`
copied API endpoint documentation from wiki.osm.org to /docs 2018-03-19 19:10:22 +03:00			`- 'Search': 'api/Search.md'`
			`- 'Reverse': 'api/Reverse.md'`
			`- 'Address Lookup': 'api/Lookup.md'`
fix links in details documentation Thanks to @JamesKingdom. 2018-08-23 21:30:07 +03:00			`- 'Details' : 'api/Details.md'`
documenation for /status endpoint 2020-05-04 18:06:06 +03:00			`- 'Status' : 'api/Status.md'`
add description of output of API 2018-08-11 15:17:41 +03:00			`- 'Place Output Formats': 'api/Output.md'`
add FAQ from nominatim.org 2018-08-11 15:47:36 +03:00			`- 'FAQ': 'api/Faq.md'`
use mkdocs for compiling the documentation Requires to shuffle around the documentation. make doc will now compile the documentation in the build directory. The markdowns created from the vagrant files are no longer versioned. 2018-01-15 01:43:15 +03:00			`- 'Administration Guide':`
			`- 'Basic Installation': 'admin/Installation.md'`
restructure developer's manual Add a section on setting up the development environment which now also includes the former chapter on recreating the documentation. Move the README from test/ into the manual as the new Testing chapter. 2020-09-17 10:54:46 +03:00			`- 'Import' : 'admin/Import.md'`
			`- 'Update' : 'admin/Update.md'`
			`- 'Deploy' : 'admin/Deployment.md'`
add usage docs for nominatim-ui Includes migration guides for Apache and nginx. 2020-06-13 21:06:01 +03:00			`- 'Nominatim UI' : 'admin/Setup-Nominatim-UI.md'`
Added Advanced Installations documentation 2020-04-15 14:48:57 +03:00			`- 'Advanced Installations' : 'admin/Advanced-Installations.md'`
use mkdocs for compiling the documentation Requires to shuffle around the documentation. make doc will now compile the documentation in the build directory. The markdowns created from the vagrant files are no longer versioned. 2018-01-15 01:43:15 +03:00			`- 'Migration from older Versions' : 'admin/Migration.md'`
			`- 'Troubleshooting' : 'admin/Faq.md'`
add develop section to documentation 2018-02-12 21:51:02 +03:00			`- 'Developers Guide':`
restructure developer's manual Add a section on setting up the development environment which now also includes the former chapter on recreating the documentation. Move the README from test/ into the manual as the new Testing chapter. 2020-09-17 10:54:46 +03:00			`- 'Setup for Development' : 'develop/Development-Environment.md'`
			`- 'Architecture Overview' : 'develop/overview.md'`
add documentation for new import style 2018-12-02 19:38:25 +03:00			`- 'OSM Data Import' : 'develop/Import.md'`
use consistent naming in doc pages 2018-11-28 00:59:18 +03:00			`- 'Place Ranking' : 'develop/Ranking.md'`
documentation: new page explaining calculated postcodes 2019-11-06 18:46:40 +03:00			`- 'Postcodes' : 'develop/Postcodes.md'`
restructure developer's manual Add a section on setting up the development environment which now also includes the former chapter on recreating the documentation. Move the README from test/ into the manual as the new Testing chapter. 2020-09-17 10:54:46 +03:00			`- 'Testing' : 'develop/Testing.md'`
docs: move external data sources into simple page 2020-07-05 12:13:28 +03:00			`- 'External Data Sources': 'develop/data-sources.md'`
use mkdocs for compiling the documentation Requires to shuffle around the documentation. make doc will now compile the documentation in the build directory. The markdowns created from the vagrant files are no longer versioned. 2018-01-15 01:43:15 +03:00			`- 'Appendix':`
			`- 'Installation on CentOS 7' : 'appendix/Install-on-Centos-7.md'`
remove Ubuntu 16 installation instructions Also fixes up CentOS 8 links in documentation. 2020-05-07 22:55:04 +03:00			`- 'Installation on CentOS 8' : 'appendix/Install-on-Centos-8.md'`
add vagrant and installation instructions for ubuntu 18 2018-08-24 22:33:24 +03:00			`- 'Installation on Ubuntu 18' : 'appendix/Install-on-Ubuntu-18.md'`
remove Ubuntu 16 installation instructions Also fixes up CentOS 8 links in documentation. 2020-05-07 22:55:04 +03:00			`- 'Installation on Ubuntu 20' : 'appendix/Install-on-Ubuntu-20.md'`
improve syntax highlighting for vagrant scripts 2018-01-16 01:47:00 +03:00			`markdown_extensions:`
switch to pygments for mkdocs hilighting 2019-10-26 00:57:23 +03:00			`- codehilite`
docs: add a note that the faltnode file is needed for updates Fixes #1644. 2020-01-22 13:44:05 +03:00			`- admonition`
cleanup documentation Remove level 3 (page title) from TOC and add permalinks. Also fix and update some minor stuff in the docs. 2018-08-24 00:12:10 +03:00			`- toc:`
			`permalink: `
switch to pygments for mkdocs hilighting 2019-10-26 00:57:23 +03:00			`extra_css: [extra.css, styles.css]`