]> git.openstreetmap.org Git - nominatim.git/blobdiff - docs/develop/Development-Environment.md
Merge pull request #2786 from lonvia/export-centroid-for-tokenizer
[nominatim.git] / docs / develop / Development-Environment.md
index 9abfae3765d049a040b2e61e8fe08ed5538f59fa..58f802f17020a3f1c12dedd1c2fdb510eb7bec9d 100644 (file)
@@ -1,6 +1,6 @@
 # Setting up Nominatim for Development
 
-This chapter gives an overview how to set up Nominatim for developement
+This chapter gives an overview how to set up Nominatim for development
 and how to run tests.
 
 !!! Important
@@ -34,12 +34,14 @@ It has the following additional requirements:
 * [PHP CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer)
 * [Pylint](https://pylint.org/) (CI always runs the latest version from pip)
 * [mypy](http://mypy-lang.org/) (plus typing information for external libs)
+* [Python Typing Extensions](https://github.com/python/typing_extensions) (for Python < 3.9)
 * [pytest](https://pytest.org)
 
 The documentation is built with mkdocs:
 
 * [mkdocs](https://www.mkdocs.org/) >= 1.1.2
-* [mkdocstrings](https://mkdocstrings.github.io/)
+* [mkdocstrings](https://mkdocstrings.github.io/) >= 0.16
+* [mkdocstrings-python-legacy](https://mkdocstrings.github.io/python-legacy/)
 
 ### Installing prerequisites on Ubuntu/Debian
 
@@ -54,7 +56,7 @@ sudo apt install php-cgi phpunit php-codesniffer \
                  python3-pip python3-setuptools python3-dev
 
 pip3 install --user behave mkdocs mkdocstrings pytest \
-                    pylint mypy types-PyYAML types-jinja2
+                    pylint mypy types-PyYAML types-jinja2 types-psycopg2
 ```
 
 The `mkdocs` executable will be located in `.local/bin`. You may have to add