safety-screen/Nominatim
1
0
Fork 0
forked from hans/Nominatim
Code Pull Requests Activity

some reformatting of documentation changes and typo fixes

Browse Source 
The newest mkdocs is more demanding when it comes to code block
formatting.
This commit is contained in:
Sarah Hoffmann
2019-11-06 22:34:43 +01:00
parent dea1d67d03
commit b5fb8608ba
2 changed files with 38 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
docs/develop/Documentation.md
View File

@@ -1,32 +1,36 @@
# Documentation Pages # Documentation Pages
The [Nominatim documentation](https://nominatim.org/release-docs/develop/) is built using the [MkDocs](https://www.mkdocs.org/) static site generation framework. The master branch is automatically deployed every night on under [https://nominatim.org/release-docs/develop/]() The [Nominatim documentation](https://nominatim.org/release-docs/develop/) is built using the [MkDocs](https://www.mkdocs.org/) static site generation framework. The master branch is automatically deployed every night on under [https://nominatim.org/release-docs/develop/](https://nominatim.org/release-docs/develop/)
To preview local changes: To preview local changes, first install MkDocs
1. Install MkDocs ```
pip3 install --user mkdocs
``` ```
pip3 install --user mkdocs
```
2. In build directory run Then go to the build directory and run
make doc ```
INFO - Cleaning site directory make doc
INFO - Building documentation to directory: /home/vagrant/build/site-html INFO - Cleaning site directory
INFO - Building documentation to directory: /home/vagrant/build/site-html
```
This runs `mkdocs build` plus extra transformion of some files and adds symlinks (see `CMakeLists.txt` for the exact steps). This runs `mkdocs build` plus extra transformation of some files and adds
symlinks (see `CMakeLists.txt` for the exact steps).
Now you can start webserver for local testing
3. Start webserver for local testing ```
build> mkdocs serve
[server:296] Serving on http://127.0.0.1:8000
[handlers:62] Start watching changes
```
mkdocs serve If you develop inside a Vagrant virtual machine:
[server:296] Serving on http://127.0.0.1:8000
[handlers:62] Start watching changes
If you develop inside a Vagrant virtual machine: * add port forwarding to your Vagrantfile,
* add port forwarding to your Vagrantfile, e.g. `config.vm.network "forwarded_port", guest: 8000, host: 8000` e.g. `config.vm.network "forwarded_port", guest: 8000, host: 8000`
* use `mkdocs serve --dev-addr 0.0.0.0:8000` because the default localhost * use `mkdocs serve --dev-addr 0.0.0.0:8000` because the default localhost
IP does not get forwarded. IP does not get forwarded.

25
docs/develop/Postcodes.md
View File

@@ -1,18 +1,20 @@
# Postcodes in Nominatim # Postcodes in Nominatim
The blog post [Nominatim and Postcodes](https://www.openstreetmap.org/user/lonvia/diary/43143) The blog post [Nominatim and Postcodes](https://www.openstreetmap.org/user/lonvia/diary/43143)
describes the new handling in Nominatim 3.1. describes the handling implemented since Nominatim 3.1.
Postcode centroids (aka 'calculated postcodes') are generated by looking at all postcodes of Postcode centroids (aka 'calculated postcodes') are generated by looking at all
a country, grouping them and calculating the geometric centroid. There is currently no logic postcodes of a country, grouping them and calculating the geometric centroid.
to deal with extreme outliers (typos or other mistakes in OSM data). There is also no check There is currently no logic to deal with extreme outliers (typos or other
if a postcodes adhere's to a countries format, e.g. if Swiss postcodes are 4 digits. mistakes in OSM data). There is also no check if a postcodes adheres to a
country's format, e.g. if Swiss postcodes are 4 digits.
## Regular updating calculated postcodes ## Regular updating calculated postcodes
The script to rerun the calculation is `build/utils/update.php --calculate-postcodes` and The script to rerun the calculation is
runs once per night on nominatim.openstreetmap.org. `build/utils/update.php --calculate-postcodes`
and runs once per night on nominatim.openstreetmap.org.
## Finding places that share a specific postcode ## Finding places that share a specific postcode
@@ -20,10 +22,11 @@ runs once per night on nominatim.openstreetmap.org.
In the Nominatim database run In the Nominatim database run
```sql ```sql
SELECT osm_type, osm_id, class, type, st_x(centroid) as lon, st_y(centroid) at lat SELECT osm_type, osm_id, class, type,
FROM placex st_x(centroid) as lon, st_y(centroid) at lat
WHERE country_code='fr' FROM placex
AND upper(trim (both ' ' from address->'postcode')) = '33210'; WHERE country_code='fr'
AND upper(trim (both ' ' from address->'postcode')) = '33210';
``` ```
Alternatively on [Overpass](https://overpass-turbo.eu/) run the following query Alternatively on [Overpass](https://overpass-turbo.eu/) run the following query