Sarah Hoffmann
196dc2a659
docs: add types-psutil requirement
2022-08-08 09:46:25 +02:00
Sarah Hoffmann
eecc73ea1a
docs: fix dangling links
2022-08-05 15:29:43 +02:00
Sarah Hoffmann
9864b191b1
fix various typos
2022-07-31 17:10:35 +02:00
Sarah Hoffmann
e7574f119e
add simple examples of sanitizers and token analysis
2022-07-29 17:15:25 +02:00
Sarah Hoffmann
51b6d16dc6
overhaul the token analysis interface
...
The functional split betweenthe two functions is now that the
first one creates the ID that is used in the word table and
the second one creates the variants. There no longer is a
requirement that the ID is the normalized version. We might
later reintroduce the requirement that a normalized version be available
but it doesn't necessarily need to be through the ID.
The function that creates the ID now gets the full PlaceName. That way
it might take into account attributes that were set by the sanitizers.
Finally rename both functions to something more sane.
2022-07-29 15:14:11 +02:00
Sarah Hoffmann
34d27ed45c
move PlaceName into the generic data module
2022-07-29 11:42:20 +02:00
Sarah Hoffmann
f0d640961a
add documentation for custom token analysis
2022-07-29 09:41:28 +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
Kian-Meng Ang
f5e52e748f
docs: fix typos
2022-07-20 22:05:31 +08:00
Sarah Hoffmann
83054af46f
remove typing_extensions requirement
...
The typing_extensions package is only necessary now when running mypy.
It won't be used at runtime anymore.
2022-07-18 09:55:58 +02:00
Sarah Hoffmann
9d716f0f7d
mypy: add psycopg2 typing info from typeshed
2022-07-18 09:47:57 +02:00
Sarah Hoffmann
a87cb77ce8
document use of mypy
2022-07-18 09:47:57 +02:00
Sarah Hoffmann
37b2c6a830
port legacy tokenizer to new postcode handling
...
Also documents the changes to the SQL functions of the tokenizer.
2022-06-23 23:42:31 +02:00
Sarah Hoffmann
d8623d6818
bdd: remove support for scenes
...
Only keep support for the special point geometry 'country:xx'.
2022-06-17 11:54:18 +02:00
Sarah Hoffmann
b5ac546275
CI: always use the latest version of pylint
...
This makes it easier to reproduce issues locally.
2022-05-31 09:12:26 +02:00
Marc Tobias
0de83c4a51
fix typos of name Nominatim
2022-05-05 01:04:47 +02:00
Sarah Hoffmann
79aeb31088
restrict PHPUnit to 9.5 version
...
There are so many breaking changes with PHPUnit that it is
impossible to give any other guarantees.
2021-12-07 14:49:31 +01:00
Sarah Hoffmann
addfae31b6
fix typo
2021-11-02 11:09:17 +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
2635fe8b4c
docs: fix more links
2021-10-18 17:26:14 +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
e52b801cd0
fix typo
2021-10-18 09:03:07 +02:00
Sarah Hoffmann
c6fdcf9b0d
adapt documentation for SQL tokenizer interface
2021-09-27 11:36:19 +02:00
Sarah Hoffmann
3656eed9ad
add mkdocstrings requirement for building docs
...
mkdocstrings also needs access to the Python sources, so set
a PYTHONPATH accordingly. This makes running mkdocs directly
a bit awkward, therefore add a `make serve-doc` target.
2021-08-16 11:51:49 +02:00
Sarah Hoffmann
2e82a6ce03
docs: extend explanation of query phrase
2021-08-16 11:51:49 +02:00
Sarah Hoffmann
c4b8a3b768
add documentation for PHP part of tokenizer
2021-08-16 11:51:49 +02:00
Sarah Hoffmann
78d11fe628
document tokenizer SQL interface
2021-08-16 11:41:54 +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
e25e268e2e
docs: querying and tokenizers
2021-08-16 08:59:44 +02:00
Sarah Hoffmann
68bff31cc9
docs: add developer doc page for Tokenizer
2021-08-16 08:58:56 +02:00
Sarah Hoffmann
c216144dd1
add missing pyyaml requirement
2021-07-07 11:29:33 +02:00
Sarah Hoffmann
e8cfba1b10
pytest may also be installed as py-test[-3]
2021-01-15 17:22:31 +01:00
Sarah Hoffmann
438ed431dd
add documentation for new pytest tests
2021-01-15 15:18:45 +01:00
Sarah Hoffmann
d9998bfab3
pylint may be available as pylint3 or pylint
2021-01-15 10:52:25 +01:00
Sarah Hoffmann
de724aa576
add pylint to list of required linting tools
...
With pylint being run in the CI, passing it is required now.
2021-01-15 10:43:04 +01:00
Sarah Hoffmann
1c1e951826
adapt documentation to new nominatim cli tool
2021-01-14 12:12:38 +01:00
Sarah Hoffmann
3bed5516da
update documentation for new BDD API tests
2021-01-09 17:54:45 +01:00
Sarah Hoffmann
2ecec19df0
remove nose requirement from documentation
2021-01-03 17:23:44 +01:00
Sarah Hoffmann
45148c7078
switch documentation to describing dotenv
2020-12-20 12:09:27 +01:00
Sarah Hoffmann
3c75194448
adapt instructions for creating the test db to dotenv
2020-12-20 11:53:19 +01:00
Sarah Hoffmann
603367dced
updates to admin and develop documentation
...
Mostly minor updates in wording and resource consumption.
2020-12-08 17:47:38 +01:00
Sarah Hoffmann
d86cf6801f
remove tests for HTML output
2020-10-29 11:13:32 +01:00
Sarah Hoffmann
b661c66c00
reorganize ranks of high-level place types
...
Rank 25 is now available for places that should appear in addresses
but not when a street is present. Use this for som block-like
place types. Also document the particularity of rank 25.
subdevisions and allotments are now at the same level as landuse
which they are frequently used together with.
2020-10-20 20:20:49 +02:00
Ben Antony
0dad470eb9
Update broken links in documentation
2020-09-18 22:52:59 +02:00
Sarah Hoffmann
dbe025fe40
docs: fix formatting
2020-09-17 10:16:25 +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
a692bfa8f9
docs: add tables for the meaning of address and search ranks
...
Also makes tables a bit more readable by adding margins and better
headers.
2020-08-11 11:48:55 +02:00
