Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 802 Bytes

CONTRIBUTING.md

File metadata and controls

40 lines (28 loc) · 802 Bytes
Raw

Development - Contributing

Issues and pull requests are more than welcome: https://github.com/developmentseed/titiler/issues

dev install

$ git clone https://github.com/developmentseed/titiler.git
$ cd titiler
$ pip install -e .[dev]

Python3.7 only

This repo is set to use pre-commit to run isort, flake8, pydocstring, black ("uncompromising Python code formatter") and mypy when committing new code.

$ pre-commit install

Docs

$ git clone https://github.com/developmentseed/titiler.git
$ cd titiler
$ pip install -e .["docs"]

Hot-reloading docs:

$ mkdocs serve

To manually deploy docs (note you should never need to do this because Github Actions deploys automatically for new commits.):

$ mkdocs gh-deploy