Update bits

.devcontainer/devcontainer.json

@@ -0,0 +1,8 @@
+{
+	"name": "Python 3",
+	"image": "mcr.microsoft.com/devcontainers/python:1-3.11-bookworm",
+	"features": {
+		"ghcr.io/devcontainers-contrib/features/pipenv:2": {}
+	},
+	"postCreateCommand": "pipenv sync --dev"
+}

.github/workflows/continuous-deployment.yml

@@ -9,11 +9,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
-          python-version: '3.10'
+          python-version: '3.11'
           cache: 'pipenv'
 
       - id: install-pipenv
@@ -34,13 +34,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - id: setup-python
         name: Setup Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
-          python-version: '3.10'
+          python-version: '3.11'
           cache: 'pipenv'
 
       - id: install-pipenv
@@ -95,11 +95,11 @@ jobs:
     needs: [test-python]
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
-          python-version: '3.10'
+          python-version: '3.11'
           cache: 'pipenv'
 
       - id: install-pipenv
@@ -125,7 +125,7 @@ jobs:
 
       - id: save
         name: Save artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: test-release-${{ github.run_number }}
           path: ./dist
@@ -139,7 +139,7 @@ jobs:
     steps:
       - id: fetch
         name: Fetch artifact
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: test-release-${{ github.run_number }}
           path: ./dist

.github/workflows/docs.yml

@@ -1,29 +1,75 @@
 name: "Build documentation"
+
 on:
   push:
-  pull_request:
   workflow_dispatch:
 
 jobs:
-  docs:
-    name: "Build and deploy"
+  build:
+    name: Build
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-
-    - uses: ammaraskar/sphinx-action@master
-      with:
-        docs-folder: "docs/"
-
-    - uses: actions/upload-artifact@v1
-      with:
-        name: documentation-html
-        path: docs/_build/html/
-
-    - uses: shallwefootball/s3-upload-action@master
-      with:
-        aws_key_id: ${{ secrets.PALEWIRE_DOCS_AWS_ACCESS_KEY_ID }}
-        aws_secret_access_key: ${{ secrets.PALEWIRE_DOCS_AWS_SECRET_ACCESS_KEY }}
-        aws_bucket: ${{ secrets.PALEWIRE_DOCS_AWS_BUCKET }}
-        source_dir: docs/_build/html/
-        destination_dir: nasa-wildfires
+      - id: checkout
+        name: Checkout
+        uses: actions/checkout@v4
+
+      - id: setup-python
+        name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+          cache: 'pipenv'
+
+      - id: install-pipenv
+        name: Install pipenv
+        run: curl https://raw.githubusercontent.com/pypa/pipenv/master/get-pipenv.py | python
+        shell: bash
+
+      - id: install-python-dependencies
+        name: Install Python dependencies
+        run: pipenv sync --dev
+        shell: bash
+
+      - id: build-sphinx-documentation
+        name: Build Sphinx documentation
+        run: pipenv run make html
+        shell: bash
+        working-directory: docs
+
+      - id: upload-release-candidate
+        name: Upload release candidate
+        uses: actions/upload-artifact@v3
+        with:
+          name: release-candidate
+          path: ./docs/_build/html/
+
+  deploy:
+    name: Deploy
+    runs-on: ubuntu-latest
+    needs: build
+    if: ${{ github.ref_name == 'main' }}
+    steps:
+      - name: Download release candidate
+        uses: actions/download-artifact@v3
+        with:
+          name: release-candidate
+          path: ./docs/
+
+      - id: configure-aws
+        name: Configure AWS Credentials
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          aws-access-key-id: ${{ secrets.PALEWIRE_DOCS_AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.PALEWIRE_DOCS_AWS_SECRET_ACCESS_KEY }}
+          aws-region: us-east-1
+
+      - id: upload-to-s3
+        name: Upload documentation to Amazon S3
+        uses: datadesk/delivery-deploy-action@v1
+        with:
+          bucket: ${{ secrets.PALEWIRE_DOCS_AWS_BUCKET }}
+          base-path: nasa-wildfires/
+          dir: ./docs/
+          should-cache: false
+          use-accelerate-endpoint: false
+          public: true

Pipfile

@@ -13,6 +13,8 @@ mypy = "*"
 types-requests = "*"
 rich = "*"
 types-retry = "*"
+sphinx-palewire-theme = "*"
+myst-parser = "*"
 
 [packages]
 requests = "*"
@@ -21,4 +23,4 @@ click = "*"
 retry = "*"
 
 [requires]
-python_version = "3.10"
+python_version = "3.11"