Skip to content

Latest commit

 

History

History
48 lines (35 loc) · 895 Bytes

CONTRIBUTING.md

File metadata and controls

48 lines (35 loc) · 895 Bytes
Raw

Contributing

Issues and pull requests are more than welcome.

dev install

git clone https://github.com/stac-utils/stac-fastapi.git
cd stac-fastapi
python -m pip install -e stac_fastapi/api[dev]

pre-commit

This repo is set to use pre-commit to run ruff, pydocstring and mypy when committing new code.

pre-commit install

Docs

git clone https://github.com/stac-utils/stac-fastapi.git
cd stac-fastapi
python pip install -e stac_fastapi/api["docs"]

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.):

Create API documentations
$ pdocs as_markdown \
  --output_dir docs/src/api/ \
  --exclude_source \
  --overwrite \
  stac_fastapi

# deploy
$ mkdocs gh-deploy -f docs/mkdocs.yml