Sarah Hoffmann
8c73c0795e
docs: update links to vagrant instructions
2022-08-05 15:27:11 +02:00
Sarah Hoffmann
3746befd88
add documentation for sanitizer interface
...
Also switches mkdocstrings to 0.18 with the rather unfortunate
consequence that now mkdocstrings-python-legacy is needed as well.
2022-07-28 22:00:29 +02:00
Marc Tobias
a6dab5e300
Vagrant and CI tests for Ubuntu 22.04
2022-07-09 22:03:48 +02:00
Sarah Hoffmann
6f15306766
docs: replace deprecated pages option
...
Fixes #2661 .
2022-06-29 20:30:28 +02:00
Sarah Hoffmann
5be320368c
add documentation for postcode customization
2022-06-23 23:42:31 +02:00
Sarah Hoffmann
aefca48e78
remove installation instructions for CentOS 7
...
This ends official support for CentOS 7.
2021-12-06 16:05:27 +01:00
Sarah Hoffmann
5b86b2078a
docs: add overview over indexing
2021-11-01 11:04:03 +01:00
Sarah Hoffmann
a069479340
docs: section about database layout
...
Replaces the import description which basically was
table layout only now.
2021-10-29 12:03:22 +02:00
Sarah Hoffmann
48be8c33ba
docs: add new maintenance section
...
currently used for postcode updates, word count updates and
deleted relations.
2021-10-28 09:22:37 +02:00
Sarah Hoffmann
f4acfed48f
add extended documentation of settings
2021-10-18 16:30:52 +02:00
Sarah Hoffmann
bbb9a41ea4
docs: move place ranking into customization part
2021-10-18 09:04:06 +02:00
Sarah Hoffmann
a3f8a097a1
docs: move import style description to customize section
2021-10-18 09:04:06 +02:00
Sarah Hoffmann
751563644f
docs: make customization chapter a separate section
2021-10-18 09:04:01 +02:00
Sarah Hoffmann
90b40fc3e6
define formal public Python interface for tokenizer
...
This introduces an abstract class for the Tokenizer/Analyzer
for documentation purposes.
2021-08-16 11:41:54 +02:00
Sarah Hoffmann
5dd24b3ef0
add documentation for ICU tokenizer configuration
2021-07-04 10:28:20 +02:00
Sarah Hoffmann
41b9bc9984
add documentation for external postcode feature
2021-05-13 14:15:42 +02:00
Sarah Hoffmann
2b11a47a2f
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 09:54:46 +02:00
Sarah Hoffmann
cf4f62c82c
docs: move webserver installation into separate chapter
2020-09-15 23:51:25 +02:00
Sarah Hoffmann
5f8d5f10a6
docs: rename documentation chapter
...
Avoids confusion about this being the documentation itself.
2020-07-05 11:14:48 +02:00
Sarah Hoffmann
f02d4d9677
docs: move external data sources into simple page
2020-07-05 11:13:28 +02:00
marc tobias
64ace51e02
move data-sources/ directory in new git repos
2020-07-01 17:38:44 +02:00
marc tobias
2e5bdb8794
Put install instructions of test tools into separate docs/ markdown file
2020-06-20 03:48:07 +02:00
Sarah Hoffmann
84403b47cb
add usage docs for nominatim-ui
...
Includes migration guides for Apache and nginx.
2020-06-13 20:09:20 +02:00
Sarah Hoffmann
42f6371e47
remove Ubuntu 16 installation instructions
...
Also fixes up CentOS 8 links in documentation.
2020-05-07 21:55:04 +02:00
marc tobias
0fb93b1e8a
documenation for /status endpoint
2020-05-04 17:06:06 +02:00
Sarah Hoffmann
77e7f4696b
fix docs typos
2020-04-26 15:00:28 +02:00
K Rahul Reddy
42f86329a9
Added Advanced Installations documentation
2020-04-17 21:53:41 +05:30
Sarah Hoffmann
69e31baf68
docs: add a note that the faltnode file is needed for updates
...
Fixes #1644 .
2020-01-22 11:44:05 +01:00
marc tobias
dea1d67d03
documentation: new page explaining calculated postcodes
2019-11-06 22:15:44 +01:00
Sarah Hoffmann
26f47d2eb7
switch to pygments for mkdocs hilighting
2019-10-25 23:57:23 +02:00
TC Haddad
5e45e0b3d7
Gsoc2019 contributions for adding Wikidata to Nominatim ( #1475 )
...
Complete rewrite of wikipedia processing scripts, addition of processing wikidata, new data source, new documentation by @tchaddad during Google Summer of Code 2019 project.
2019-10-06 15:56:39 +08:00
marc tobias
3b39cfb1cf
New readme file on how to build the documentation
2019-07-21 21:31:14 +02:00
Sarah Hoffmann
a90ace7fa1
add documentation for new import style
2019-01-08 22:54:41 +01:00
Marc Tobias Metten
61769a1bad
GB postcode: new conversion script, documentation
2018-12-03 18:43:28 +01:00
Sarah Hoffmann
c68833cd7f
Merge branch 'document-osm-country-grid' of https://github.com/mtmail/Nominatim
2018-12-01 22:20:50 +01:00
marc tobias
8e19336f49
document what country_osm_grid does
2018-11-29 17:06:04 +01:00
Sarah Hoffmann
96a84294f4
use consistent naming in doc pages
2018-11-27 22:59:18 +01:00
Sarah Hoffmann
211214a8d3
Add documentation for new ranking level configuration
2018-11-24 16:21:16 +01:00
Sarah Hoffmann
36398eedca
docs: more specific chapter title
2018-11-15 23:01:08 +01:00
marc tobias
aa41b813b8
2018 TIGER data conversion scripts, add documentation to /docs/data-sources
2018-11-15 23:01:08 +01:00
Sarah Hoffmann
6e3670bce5
add vagrant and installation instructions for ubuntu 18
2018-08-24 21:33:24 +02:00
Sarah Hoffmann
e7b738fe35
cleanup documentation
...
Remove level 3 (page title) from TOC and add permalinks.
Also fix and update some minor stuff in the docs.
2018-08-23 23:14:41 +02:00
Sarah Hoffmann
c80c80200c
fix links in details documentation
...
Thanks to @JamesKingdom.
2018-08-23 20:30:07 +02:00
Sarah Hoffmann
569184a5b0
add FAQ from nominatim.org
2018-08-11 14:47:36 +02:00
Sarah Hoffmann
41c4b51be5
add description of output of API
2018-08-11 14:17:41 +02:00
Sarah Hoffmann
d2b9493d72
clean up and format search documentation
2018-08-09 21:47:57 +02:00
marc tobias
90d531c640
copied API endpoint documentation from wiki.osm.org to /docs
2018-03-19 17:10:22 +01:00
Sarah Hoffmann
de9507bc63
add develop section to documentation
2018-02-24 23:24:25 +01:00
Sarah Hoffmann
d4110eef7e
improve syntax highlighting for vagrant scripts
2018-01-15 23:47:00 +01:00
Sarah Hoffmann
b8f7563da9
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-14 23:43:15 +01:00