CONTRIBUTING.md

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.8 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

   pdocs as_markdown \
   --output_dir docs/api \
   --exclude_source \
   --overwrite \
   titiler.core.dependencies \
   titiler.core.factory \
   titiler.core.utils \
   titiler.core.routing \
   titiler.core.errors \
   titiler.core.resources.enums

   pdocs as_markdown \
   --output_dir docs/api \
   --exclude_source \
   --overwrite \
   titiler.mosaic.factory \
   titiler.mosaic.resources.enums \
   titiler.mosaic.errors

   pdocs as_markdown \
   --output_dir docs/api \
   --exclude_source \
   --overwrite \
   titiler.application.middleware