second pass

Author: jonhealy1

.gitignore

@@ -135,4 +135,6 @@ dmypy.json
 # Virtualenv
 venv
 
+/docs/src/api
+
 .DS_Store

CONTRIBUTING.md

@@ -0,0 +1,48 @@
+# Contributing
+
+Issues and pull requests are more than welcome.
+
+**dev install**
+
+```bash
+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.
+
+```bash
+pre-commit install
+```
+
+### Docs
+
+```bash
+git clone https://github.com/stac-utils/stac-fastapi.git
+cd stac-fastapi
+python pip install -e stac_fastapi/api["docs"]
+```
+
+Hot-reloading docs:
+
+```bash
+$ 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.):
+
+```bash
+Create API documentations
+$ pdocs as_markdown \
+  --output_dir docs/src/api/ \
+  --exclude_source \
+  --overwrite \
+  stac_fastapi.opensearch
+
+# deploy
+$ mkdocs gh-deploy -f docs/mkdocs.yml
+```

Dockerfile.docs

@@ -11,14 +11,22 @@ COPY . /opt/src
 WORKDIR /opt/src
 
 RUN python -m pip install \
-    stac_fastapi/api \
-    stac_fastapi/types \
-    stac_fastapi/elasticsearch
+    stac_fastapi/core \
+    stac_fastapi/elasticsearch \
+    stac_fastapi/opensearch
+
+# CMD ["pdocs", \
+#     "as_markdown", \
+#     "--output_dir", \
+#     "docs/src/api/", \
+#     "--exclude_source", \
+#     "--overwrite", \
+#     "stac_fastapi.core"]
 
 CMD ["pdocs", \
     "as_markdown", \
     "--output_dir", \
-    "docs/elasticsearch/", \
+    "docs/src/api/", \
     "--exclude_source", \
     "--overwrite", \
-    "stac_fastapi.elasticsearch"]
+    "stac_fastapi"]

docker-compose.docs.yml

@@ -8,11 +8,18 @@ services:
       dockerfile: Dockerfile.docs
     platform: linux/amd64
     environment:
-      - POSTGRES_USER=username
-      - POSTGRES_PASS=password
-      - POSTGRES_DBNAME=postgis
-      - POSTGRES_HOST_READER=database
-      - POSTGRES_HOST_WRITER=database
-      - POSTGRES_PORT=5432
+    - STAC_FASTAPI_TITLE=stac-fastapi-opensearch
+    - STAC_FASTAPI_DESCRIPTION=A STAC FastAPI with an Opensearch backend
+    - STAC_FASTAPI_VERSION=2.1
+    - APP_HOST=0.0.0.0
+    - APP_PORT=8082
+    - RELOAD=true
+    - ENVIRONMENT=local
+    - WEB_CONCURRENCY=10
+    - ES_HOST=opensearch
+    - ES_PORT=9202
+    - ES_USE_SSL=false
+    - ES_VERIFY_CERTS=false
+    - BACKEND=opensearch
     volumes:
       - .:/opt/src

docs/mkdocs.yml

@@ -4,7 +4,7 @@ site_description: STAC FastAPI.
 # Repository
 repo_name: "stac-utils/stac-fastapi-elasticsearch-opensearch"
 repo_url: "https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch"
-edit_uri: "blob/main/docs/src/"
+edit_uri: "blob/makedocs/docs/src/"
 
 docs_dir: 'src'
 site_dir: 'build'
@@ -17,16 +17,38 @@ extra:
 
 # Layout
 nav:
-  - Home: "index.md"
+  - Home: index.md
   - Tips and Tricks: tips-and-tricks.md
-  - ELASTICSEARCH:
-      - packages: elasticsearch/stac_fastapi/index.md
+  - API:
       - stac_fastapi.elasticsearch:
-          - module: elasticsearch/stac_fastapi/elasticsearch/index.md
-          - app: elasticsearch/stac_fastapi/elasticsearch/app.md
-          - config: elasticsearch/stac_fastapi/elasticsearch/config.md
-          - database_logic: elasticsearch/stac_fastapi/elasticsearch/database_logic.md
-          - version: elasticsearch/stac_fastapi/elasticsearch/version.md
+          - app: api/stac_fastapi/elasticsearch/app.md
+          - module: api/stac_fastapi/elasticsearch/index.md
+          - config: api/stac_fastapi/elasticsearch/config.md
+          - database_logic: api/stac_fastapi/elasticsearch/database_logic.md
+          - index: api/stac_fastapi/elasticsearch/index.md
+          - version: api/stac_fastapi/elasticsearch/version.md
+      - stac_fastapi.opensearch:
+          - app: api/stac_fastapi/opensearch/app.md
+          - module: api/stac_fastapi/opensearch/index.md
+          - config: api/stac_fastapi/opensearch/config.md
+          - database_logic: api/stac_fastapi/opensearch/database_logic.md
+          - index: api/stac_fastapi/opensearch/index.md
+          - version: api/stac_fastapi/opensearch/version.md
+      - stac_fastapi.core:
+          - module: api/stac_fastapi/core/index.md
+          - base_database_logic: api/stac_fastapi/core/base_database_logic.md
+          - base_settings: api/stac_fastapi/core/base_settings.md
+          - core: api/stac_fastapi/core/core.md
+          - extensions:
+            - module: api/stac_fastapi/core/extensions/index.md
+            - filter: api/stac_fastapi/core/extensions/filter.md
+            - query: api/stac_fastapi/core/extensions/query.md
+          - models:
+            - module: api/stac_fastapi/core/models/index.md
+            - links: api/stac_fastapi/core/models/links.md
+            - search: api/stac_fastapi/core/models/search.md
+          - serializers: api/stac_fastapi/core/serializers.md
+          - version: api/stac_fastapi/core/version.md
   - Development - Contributing: "contributing.md"
   - Release Notes: "release-notes.md"
 

docs/src/contributing.md

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

docs/src/index.md

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

docs/src/stylesheets/extra.css

@@ -0,0 +1,3 @@
+:root {
+    --md-primary-fg-color:        rgb(13, 118, 160);
+  }