]> git.openstreetmap.org Git - nominatim.git/blob - docs/index.md
update to modern mkdocstrings python handler
[nominatim.git] / docs / index.md
1 Nominatim (from the Latin, 'by name') is a tool to search OSM data by name and address and to generate synthetic addresses of OSM points (reverse geocoding).
2
3 This guide comes in four parts:
4
5  * __[API reference](api/Overview.md)__ for users of Nominatim
6  * __[Administration Guide](admin/Installation.md)__ for those who want
7    to install their own Nominatim server
8  * __[Customization Guide](customize/Overview.md)__ for those who want to
9    adapt their own installation to their special requirements
10  * __[Developer's Guide](develop/overview.md)__ for developers of the software