Merge branch 'master' of https://github.com/developmentseed/tifeatures into Queryables

Author: vincentsarago

.env.example

@@ -1 +1,3 @@
+
+TIFEATURES_NAME="OGC Feature API"
 DATABASE_URL=postgresql://username:[email protected]:5439/postgis

.github/workflows/deploy_mkdocs.yml

@@ -0,0 +1,56 @@
+name: Publish docs via GitHub Pages
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      # Only rebuild website when docs have changed
+      - 'README.md'
+      - 'CHANGES.md'
+      - 'CONTRIBUTING.md'
+      - 'docs/**'
+
+jobs:
+  build:
+    name: Deploy docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout master
+        uses: actions/checkout@v2
+
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e .["docs"]
+
+      - name: Create API docs
+        env:
+          # we need to set a fake PG url or import will fail
+          DATABASE_URL: postgresql://username:[email protected]:5439/postgis
+        run: |
+          pdocs as_markdown \
+            --output_dir docs/src/api \
+            --exclude_source \
+            --overwrite \
+            tifeatures.filter.evaluate \
+            tifeatures.filter.filters \
+            tifeatures.resources.enums \
+            tifeatures.resources.response \
+            tifeatures.db \
+            tifeatures.dbmodel \
+            tifeatures.dependencies \
+            tifeatures.errors \
+            tifeatures.factory \
+            tifeatures.layer \
+            tifeatures.middleware \
+            tifeatures.model \
+            tifeatures.settings
+
+      - name: Deploy docs
+        run: mkdocs gh-deploy --force -f docs/mkdocs.yml

.gitignore

@@ -108,3 +108,4 @@ cdk.out/
 benchmark/
 
 .pgdata/
+docs/src/api/*

README.md

@@ -1,8 +1,7 @@
 <p align="center">
   <img width="500" src="https://user-images.githubusercontent.com/10407788/172736520-18da1910-87ac-41a9-b6f0-6c6ae503bd5e.png"/>
-  <p align="center">Simple and Fast Geospatial Feature Server for PostGIS.</p>
+  <p align="center">Simple and Fast Geospatial Features API for PostGIS.</p>
 </p>
-
 <p align="center">
   <a href="https://github.com/developmentseed/tifeatures/actions?query=workflow%3ACI" target="_blank">
       <img src="https://github.com/developmentseed/tifeatures/workflows/CI/badge.svg" alt="Test">
@@ -18,11 +17,12 @@
 
 ---
 
+**Documentation**: <a href="https://developmentseed.org/tifeatures/" target="_blank">https://developmentseed.org/tifeatures/</a>
+
 **Source Code**: <a href="https://github.com/developmentseed/tifeatures" target="_blank">https://github.com/developmentseed/tifeatures</a>
 
 ---
 
-
 ## Install
 
 ```bash
@@ -36,6 +36,8 @@ $ python -m pip install -e .  # or .["all"] to install optional dependencies
 ```bash
 $ pip install uvicorn
 
+# Set you postgis database instance URL in the environment
+$ export DATABASE_URL=postgresql://username:[email protected]:5432/postgis
 $ uvicorn tifeatures.main:app
 ```
 
@@ -52,6 +54,14 @@ Example of `.env` file can be found in [.env.example](https://github.com/develop
 DATABASE_URL=postgresql://username:[email protected]:5432/postgis
 ```
 
+## OGC Specification
+
+Specification | Status | link |
+|          -- |     -- |   -- |
+Part 1: Core             | ✅ | https://docs.ogc.org/is/17-069r4/17-069r4.html
+Part 2: CRS by Reference | ❌ | https://docs.ogc.org/is/18-058r1/18-058r1.html
+Part 3: Filtering / CQL2 | ✅ | https://docs.ogc.org/DRAFTS/19-079r1.html
+
 ## Contribution & Development
 
 See [CONTRIBUTING.md](https://github.com/developmentseed/tifeatures/blob/master/CONTRIBUTING.md)

docs/mkdocs.yml

@@ -0,0 +1,77 @@
+site_name: tifeatures
+site_description: Simple and Fast Geospatial OGC Features API for PostGIS.
+
+docs_dir: 'src'
+site_dir: 'build'
+
+repo_name: "developmentseed/tifeatures"
+repo_url: "https://github.com/developmentseed/tifeatures"
+
+extra:
+  social:
+    - icon: "fontawesome/brands/github"
+      link: "https://github.com/developmentseed"
+    - icon: "fontawesome/brands/twitter"
+      link: "https://twitter.com/developmentseed"
+    - icon: "fontawesome/brands/medium"
+      link: "https://medium.com/devseed"
+
+nav:
+  - TiFeatures: "index.md"
+  - Tutorial - User Guide:
+    - "Endpoints": endpoints.md
+  - API:
+    - db: api/tifeatures/db.md
+    - dbmodel: api/tifeatures/dbmodel.md
+    - dependencies: api/tifeatures/dependencies.md
+    - errors: api/tifeatures/errors.md
+    - factory: api/tifeatures/factory.md
+    - layer: api/tifeatures/layer.md
+    - middleware: api/tifeatures/middleware.md
+    - model: api/tifeatures/model.md
+    - settings: api/tifeatures/settings.md
+    - resources:
+      - enums: api/tifeatures/resources/enums.md
+      - response: api/tifeatures/resources/response.md
+    - filters:
+      - evaluate: api/tifeatures/filter/evaluate.md
+      - filters: api/tifeatures/filter/filters.md
+  - Development - Contributing: "contributing.md"
+  - Release Notes: "release-notes.md"
+
+plugins:
+  - search
+
+theme:
+  name: material
+  palette:
+    primary: indigo
+    scheme: default
+  favicon: img/favicon.ico
+
+markdown_extensions:
+  - admonition
+  - attr_list
+  - codehilite:
+      guess_lang: false
+  - def_list
+  - footnotes
+  - pymdownx.arithmatex
+  - pymdownx.betterem
+  - pymdownx.caret:
+      insert: false
+  - pymdownx.details
+  - pymdownx.emoji
+  - pymdownx.escapeall:
+      hardbreak: true
+      nbsp: true
+  - pymdownx.magiclink:
+      hide_protocol: true
+      repo_url_shortener: true
+  - pymdownx.smartsymbols
+  - pymdownx.superfences
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tilde
+  - toc:
+      permalink: true

docs/src/contributing.md

@@ -0,0 +1 @@
+../../CONTRIBUTING.md