Sarah Hoffmann
c4f30de7a3
docs: remove all references to PHP
2024-09-15 16:08:26 +02:00
marc tobias
0ba3d01982
Development environment: add missing dependencies
2024-08-09 17:57:18 +02:00
Sarah Hoffmann
7282d816c8
build vagrant instructions dynamically with mkdocs-gen-files
2024-08-07 16:28:44 +02:00
Sarah Hoffmann
474aea61da
bdd tests: get rid of dependency on build path
...
BDD tests will now use whatever osm2pgsql they find in the PATH.
For testing against legacy tokenizer, use -DSERVER_MODULE_PATH
to point to the module. This will no longer work out of the box.
2024-07-31 11:16:49 +02:00
marc tobias
24f103dcbe
Documentation: typo in python package name
2024-07-08 16:44:09 +02:00
Sarah Hoffmann
ecf4693a79
improve wording
...
as per review
2024-06-29 16:27:26 +02:00
Sarah Hoffmann
139cea5720
update documentation for new directory layout
2024-06-26 11:52:47 +02:00
Sarah Hoffmann
d3372e69ec
update to modern mkdocstrings python handler
2023-08-25 21:40:20 +02:00
Sarah Hoffmann
b79d5494f9
remove support for sanic framework
...
There is no performance gain over falcon or starlette but the special
structure of sanic makes it hard to have exchangable code
2023-06-21 10:53:57 +02:00
Sarah Hoffmann
6c6b1c0606
add typing information for pygments to requirements
2023-02-14 11:58:08 +01:00
danil
7698f0672d
typo fixed
2023-02-08 00:21:58 +04:00
Sarah Hoffmann
a1d4e53eb8
add pytest-asyncio as a requirement for testing
2023-01-30 09:36:17 +01:00
Sarah Hoffmann
2156fd4909
adapt annotations for SQLAlchemy 2.x
...
It is not possible to produce type annotations that work with both
versions 1.4 and 2.0. So keep to the principle of only supporting
newest versions when it comes to mypy. This means that some types
may have to be string quoted to not cause issues when running with
SQLAlchemy 1.4.
2023-01-28 11:51:26 +01:00
Sarah Hoffmann
77bec1261e
add streaming json writer for JSON output
2023-01-25 15:05:33 +01:00
Sarah Hoffmann
cf19036ce6
docs: extend dependency documentation
2023-01-03 10:03:00 +01:00
Sarah Hoffmann
196dc2a659
docs: add types-psutil requirement
2022-08-08 09:46:25 +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
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
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
e52b801cd0
fix typo
2021-10-18 09:03:07 +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
c216144dd1
add missing pyyaml requirement
2021-07-07 11:29:33 +02: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
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
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
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