From: Sarah Hoffmann Date: Wed, 7 Aug 2024 14:58:45 +0000 (+0200) Subject: fix dangling links in documentation X-Git-Tag: deploy~4^2^2 X-Git-Url: https://git.openstreetmap.org./nominatim.git/commitdiff_plain/d1e7b85cc5871a79d808634586d4425466bb2333 fix dangling links in documentation --- diff --git a/docs/admin/Deployment-Python.md b/docs/admin/Deployment-Python.md index 821a2c06..9275bab8 100644 --- a/docs/admin/Deployment-Python.md +++ b/docs/admin/Deployment-Python.md @@ -19,8 +19,8 @@ to configure it. ### Installing the required packages The Nominatim frontend is best run from its own virtual environment. If -you have already created one for the database backend during -[installation](Installation.md#Building-Nominatim), you can use that. Otherwise +you have already created one for the database backend during the +[installation](Installation.md#building-nominatim), you can use that. Otherwise create one now with: ```sh diff --git a/docs/customize/Tokenizers.md b/docs/customize/Tokenizers.md index 6b811a9a..ee51fec0 100644 --- a/docs/customize/Tokenizers.md +++ b/docs/customize/Tokenizers.md @@ -52,7 +52,7 @@ NOMINATIM_DATABASE_MODULE_PATH= ``` This is in particular useful when the database runs on a different server. -See [Advanced installations](../admin/Advanced-Installations.md#importing-nominatim-to-an-external-postgresql-database) for details. +See [Advanced installations](../admin/Advanced-Installations.md#using-an-external-postgresql-database) for details. There are no other configuration options for the legacy tokenizer. All normalization functions are hard-coded. diff --git a/docs/library/Input-Parameter-Types.md b/docs/library/Input-Parameter-Types.md index 5c537732..d27bc96f 100644 --- a/docs/library/Input-Parameter-Types.md +++ b/docs/library/Input-Parameter-Types.md @@ -5,8 +5,8 @@ in the query functions of the API object. ## Place identification -The [details](NominatimAPI.md#nominatim_api.core.NominatimAPI.details) and -[lookup](NominatimAPI.md#nominatim_api.core.NominatimAPI.lookup) functions +The [details](NominatimAPI.md#nominatim_api.NominatimAPI.details) and +[lookup](NominatimAPI.md#nominatim_api.NominatimAPI.lookup) functions require references to places in the database. Below the possible types for place identification are listed. All types are dataclasses. diff --git a/src/nominatim_api/core.py b/src/nominatim_api/core.py index c460d98c..6c4c37d7 100644 --- a/src/nominatim_api/core.py +++ b/src/nominatim_api/core.py @@ -382,7 +382,7 @@ class NominatimAPI: @property def config(self) -> Configuration: - """ Provide read-only access to the [configuration](#Configuration) + """ Provide read-only access to the [configuration](Configuration.md) used by the API. """ return self._async_api.config diff --git a/src/nominatim_api/results.py b/src/nominatim_api/results.py index 805527a7..28c0fc1a 100644 --- a/src/nominatim_api/results.py +++ b/src/nominatim_api/results.py @@ -127,7 +127,7 @@ class AddressLine: local_name: Optional[str] = None """ Place holder for localization of this address part. See - [Localization](#localization) below. + [Localization](Result-Handling.md#localization) below. """