Redo the docs and other bits too

palewire · Dec 3, 2023 · 432f17d · 432f17d
1 parent be61f08
commit 432f17d
Show file tree

Hide file tree

Showing 11 changed files with 72 additions and 361 deletions.
diff --git a/.github/workflows/tests.yml → .github/workflows/continuous-deployment.yml b/.github/workflows/tests.yml → .github/workflows/continuous-deployment.yml
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -9,21 +9,48 @@ jobs:
     name: "Build and deploy"
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v1
+      - id: checkout
+        name: Checkout
+        uses: actions/checkout@v4
 
-    - uses: ammaraskar/sphinx-action@master
-      with:
-        docs-folder: "docs/"
+      - id: setup-python
+        name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.12'
+          cache: 'pipenv'
 
-    - uses: actions/upload-artifact@v1
-      with:
-        name: documentation-html
-        path: docs/_build/html/
+      - id: install-pipenv
+        name: Install pipenv
+        run: curl https://raw.githubusercontent.com/pypa/pipenv/master/get-pipenv.py | python
+        shell: bash
 
-    - 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: python-muckrock
+      - 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: 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: python-muckrock/
+          dir: docs/_build/html/
+          should-cache: false
+          use-accelerate-endpoint: false
+          public: true
diff --git a/Pipfile b/Pipfile
@@ -27,6 +27,7 @@ sphinxcontrib-napoleon = "*"
 sphinxcontrib-mermaid = "*"
 myst-parser = "*"
 sphinx-palewire-theme = "*"
+sphinx-click = "*"
 
 [requires]
 python_version = "3.12"
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css
diff --git a/docs/_templates/nav.html b/docs/_templates/nav.html