X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/a5970d75486bae0f0532b4e4bb12e82d625c4750..ab6f35d83a350ead4eb12b59c4cbc050e48f93ee:/docs/develop/Development-Environment.md diff --git a/docs/develop/Development-Environment.md b/docs/develop/Development-Environment.md index eea69c70..eba87c09 100644 --- a/docs/develop/Development-Environment.md +++ b/docs/develop/Development-Environment.md @@ -30,7 +30,7 @@ unit tests (using PHPUnit for PHP code and pytest for Python code). It has the following additional requirements: * [behave test framework](https://behave.readthedocs.io) >= 1.2.6 -* [phpunit](https://phpunit.de) >= 7.3 +* [phpunit](https://phpunit.de) (9.5 is known to work) * [PHP CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) * [Pylint](https://pylint.org/) (2.6.0 is used for the CI) * [pytest](https://pytest.org) @@ -38,6 +38,7 @@ It has the following additional requirements: The documentation is built with mkdocs: * [mkdocs](https://www.mkdocs.org/) >= 1.1.2 +* [mkdocstrings](https://mkdocstrings.github.io/) ### Installing prerequisites on Ubuntu/Debian @@ -51,7 +52,7 @@ To install all necessary packages run: sudo apt install php-cgi phpunit php-codesniffer \ python3-pip python3-setuptools python3-dev pylint -pip3 install --user behave mkdocs pytest +pip3 install --user behave mkdocs mkdocstrings pytest ``` The `mkdocs` executable will be located in `.local/bin`. You may have to add @@ -113,7 +114,7 @@ symlinks (see `CMakeLists.txt` for the exact steps). Now you can start webserver for local testing ``` -build> mkdocs serve +build> make serve-doc [server:296] Serving on http://127.0.0.1:8000 [handlers:62] Start watching changes ``` @@ -122,7 +123,7 @@ If you develop inside a Vagrant virtual machine, use a port that is forwarded to your host: ``` -build> mkdocs serve --dev-addr 0.0.0.0:8088 +build> PYTHONPATH=$SRCDIR mkdocs serve --dev-addr 0.0.0.0:8088 [server:296] Serving on http://0.0.0.0:8088 [handlers:62] Start watching changes ```