restructure library documentation

docs/library/Configuration.md

@@ -0,0 +1,11 @@
+# Configuration class
+
+::: nominatim.config.Configuration
+    options:
+        members:
+            - get_bool
+            - get_int
+            - get_str_list
+            - get_path
+        heading_level: 6
+        show_signature_annotations: True

docs/library/Getting-Started.md

@@ -0,0 +1,28 @@
+# Getting Started
+
+The Nominatim search frontend can directly be used as a Python library in
+scripts and applications. When you have imported your own Nominatim database,
+then it is no longer necessary to run a full web service for it and access
+the database through http requests. With the Nominatim library it is possible
+to access all search functionality directly from your Python code. There are
+also less constraints on the kinds of data that can be accessed. The library
+allows to get access to more detailed information about the objects saved
+in the database.
+
+## Installation
+
+To use the Nominatim library, you need access to a local Nominatim database.
+Follow the [installation and import instructions](../admin/) to set up your
+database.
+
+!!! warning
+    Access to the library is currently still experimental. It is not yet
+    possible to install it in the usual way via pip or inside a virtualenv.
+    To get access to the library you need to set an appropriate PYTHONPATH.
+    With the default installation, the python library can be found under
+    `/usr/local/share/nominatim/lib-python`. If you have installed Nominatim
+    under a different prefix, adapt the `/usr/local/` part accordingly.
+    You can also point the PYTHONPATH to the Nominatim source code.
+
+    A proper installation as a Python library will follow in the next
+    version.

docs/library/Input-Parameter-Types.md

@@ -0,0 +1,33 @@
+# Input parameters
+
+## Place identification
+
+::: nominatim.api.PlaceID
+    options:
+        heading_level: 6
+
+::: nominatim.api.OsmID
+    options:
+        heading_level: 6
+
+## Geometries
+
+::: nominatim.api.GeometryFormat
+    options:
+        heading_level: 6
+
+::: nominatim.api.Point
+    options:
+        heading_level: 6
+
+::: nominatim.api.Bbox
+    options:
+        heading_level: 6
+
+## Layers
+
+::: nominatim.api.DataLayer
+    options:
+        heading_level: 6
+
+

docs/library/Introduction.md

@@ -0,0 +1,12 @@
+# Nominatim Frontend as a Library
+
+The Nominatim search frontend can directly be used as a Python library in
+scripts and applications. When you have imported your own Nominatim database,
+then it is no longer necessary to run a full web service for it and access
+the database through http requests. With the Nominatim library it is possible
+to access all search functionality directly from your Python code. There are
+also less constraints on the kinds of data that can be accessed. The library
+allows to get access to more detailed information about the objects saved
+in the database.
+
+

docs/library/Low-Level-DB-Access.md

@@ -0,0 +1,5 @@
+# Low-level connections
+
+::: nominatim.api.SearchConnection
+    options:
+        heading_level: 6

docs/library/NominatimAPI.md

@@ -0,0 +1,38 @@
+# The Nominatim API classes
+
+The API classes are the core object of the search library. Always instantiate
+one of these classes first. The API classes are **not threadsafe**. You need
+to instantiate a separate instance for each thread.
+
+### NominatimAPI
+
+::: nominatim.api.NominatimAPI
+    options:
+        members:
+            - __init__
+            - config
+            - close
+            - status
+            - details
+            - lookup
+            - reverse
+            - search
+            - search_address
+            - search_category
+        heading_level: 6
+        group_by_category: False
+        show_signature_annotations: True
+
+
+### NominatimAPIAsync
+
+::: nominatim.api.NominatimAPIAsync
+    options:
+        members:
+            - __init__
+            - setup_database
+            - close
+            - begin
+        heading_level: 6
+        group_by_category: False
+        show_signature_annotations: True

docs/library/Result-Handling.md

@@ -0,0 +1,19 @@
+# Result handling
+
+::: nominatim.api.SourceTable
+    options:
+        heading_level: 6
+
+::: nominatim.api.AddressLine
+    options:
+        heading_level: 6
+
+::: nominatim.api.WordInfo
+    options:
+        heading_level: 6
+
+## Localization
+
+::: nominatim.api.Locales
+    options:
+        heading_level: 6