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
marc tobias
01b009ff24
test/README.md - more instructions how to import test db
2020-07-31 16:50:27 +02:00
Sarah Hoffmann
f02d4d9677
docs: move external data sources into simple page
2020-07-05 11:13:28 +02:00
Sarah Hoffmann
dd10c867db
docs: minor typo and grammar fixes
2020-06-23 23:31:18 +02:00
marc tobias
2e5bdb8794
Put install instructions of test tools into separate docs/ markdown file
2020-06-20 03:48:07 +02:00
marc tobias
7503987630
typo in SQL in Postcodes.md
2019-11-11 23:34:44 +01:00
Sarah Hoffmann
b5fb8608ba
some reformatting of documentation changes and typo fixes
...
The newest mkdocs is more demanding when it comes to code block
formatting.
2019-11-06 22:34:43 +01:00
marc tobias
dea1d67d03
documentation: new page explaining calculated postcodes
2019-11-06 22:15:44 +01:00
marc tobias
3b39cfb1cf
New readme file on how to build the documentation
2019-07-21 21:31:14 +02:00
Jochen Topf
634684236c
Fix some minor issues in docs.
2019-05-21 13:55:16 +02:00
Sarah Hoffmann
f1fe70656f
more style docs
2019-01-08 22:54:41 +01:00
Sarah Hoffmann
a90ace7fa1
add documentation for new import style
2019-01-08 22:54:41 +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
de9507bc63
add develop section to documentation
2018-02-24 23:24:25 +01:00
