Skip to content

Latest commit

 

History

History
66 lines (52 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

66 lines (52 loc) · 1.45 KB
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 \
   pre-commit \
   -e src/titiler/core["test"] \
   -e src/titiler/mosaic["test"] \
   -e src/titiler/application["test"]

pre-commit

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 nbconvert mkdocs mkdocs-material mkdocs-jupyter pygments pdocs

Hot-reloading docs:

$ mkdocs serve -f docs/mkdocs.yml

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

$ mkdocs gh-deploy -f docs/mkdocs.yml
   pdocs as_markdown \
   --output_dir docs/src/api \
   --exclude_source \
   --overwrite \
   titiler.core.dependencies \
   titiler.core.factory \
   titiler.core.utils \
   titiler.core.routing \
   titiler.core.errors \
   titiler.core.resources.enums \
   titiler.core.middleware

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