mirror of
https://github.com/osm-search/Nominatim.git
synced 2026-02-14 01:47:57 +00:00
Merge pull request #3970 from lonvia/improve-dev-docs
Some minor improvement to developer docs
This commit is contained in:
@@ -42,6 +42,15 @@ description or in documentation need to
|
||||
sufficient. You need to show that the code actually solves the problem
|
||||
the PR claims to solve.
|
||||
|
||||
## Getting Started with Development
|
||||
|
||||
Please see the development section of the Nominatim documentation for
|
||||
|
||||
* [an architecture overview](https://nominatim.org/release-docs/develop/develop/overview/)
|
||||
and backgrounds on some of the algorithms
|
||||
* [how to set up a development environment](https://nominatim.org/release-docs/develop/develop/Development-Environment/)
|
||||
* and background on [how tests are organised](https://nominatim.org/release-docs/develop/develop/Testing/)
|
||||
|
||||
|
||||
## Coding style
|
||||
|
||||
|
||||
@@ -56,7 +56,7 @@ The easiest way, to handle these Python dependencies is to run your
|
||||
development from within a virtual environment.
|
||||
|
||||
```sh
|
||||
sudo apt install libsqlite3-mod-spatialite osm2pgsql \
|
||||
sudo apt install build-essential libsqlite3-mod-spatialite osm2pgsql \
|
||||
postgresql-postgis postgresql-postgis-scripts \
|
||||
pkg-config libicu-dev virtualenv
|
||||
```
|
||||
@@ -68,11 +68,11 @@ virtualenv ~/nominatim-dev-venv
|
||||
~/nominatim-dev-venv/bin/pip install\
|
||||
psutil 'psycopg[binary]' PyICU SQLAlchemy \
|
||||
python-dotenv jinja2 pyYAML \
|
||||
mkdocs 'mkdocstrings[python]' mkdocs-gen-files \
|
||||
mkdocs 'mkdocstrings[python]' mkdocs-gen-files mkdocs-material \
|
||||
pytest pytest-asyncio pytest-bdd flake8 \
|
||||
types-jinja2 types-markupsafe types-psutil types-psycopg2 \
|
||||
types-pygments types-pyyaml types-requests types-ujson \
|
||||
types-urllib3 typing-extensions unicorn falcon starlette \
|
||||
types-urllib3 typing-extensions gunicorn falcon starlette \
|
||||
uvicorn mypy osmium aiosqlite mwparserfromhell
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user